Skip to main content
PATCH
/
tasks
/
{task_id}
Update a task
curl --request PATCH \
  --url https://api.deck.co/v2/tasks/{task_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "input_schema": "<unknown>",
  "output_schema": "<unknown>",
  "prompt": "<string>",
  "storage": "<unknown>"
}
'
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "status": "<string>",
  "agent_id": "<string>",
  "input_schema": "<unknown>",
  "output_schema": "<unknown>",
  "storage": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.deck.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

​
task_id
string
required

Unique identifier for the task (prefixed with task_).

Body

Request body for updating a task. Only include fields you want to change.

​
name
null | string

Updated display name.

​
input_schema
any

Updated JSON Schema for task run input.

​
output_schema
any

Updated JSON Schema for task run output.

​
prompt
null | string

Updated agent instructions.

​
storage
any

Updated storage configuration.

Response

OK

A task object. Tasks are defined actions an agent can perform.

​
id
string
required

Unique identifier for the task, prefixed with task_.

​
object
string
required

Always task.

​
name
string
required

Display name for the task.

​
prompt
null | string
required

Instructions for the agent describing what this task should do.

​
status
string
required

Task status: learning, test, or live.

​
agent_id
string
required

The agent this task belongs to. Prefixed with agt_.

​
input_schema
null | any
required

JSON Schema defining the expected input for task runs.

​
output_schema
null | any
required

JSON Schema defining the expected output for task runs.

​
storage
null | any
required

Storage configuration for file capture during task execution.

​
created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created.

​
updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

​
request_id
string
required

Unique identifier for the API request. Include this when contacting support.