Sign in
Tasks

Create a task

Creates a new task on an agent. A task is a defined action an agent can perform, such as fetching data or submitting a form.

post/tasks

Request body

namestring required

Display name for the task.

agent_idstring required

The agent this task belongs to. Prefixed with agt_.

idstring nullable

Optional client-specified ID for the task. If not provided, Deck generates one.

{"stackTrail":"components:schemas:CreateTaskRequest:properties:input_schema","oasType":"schema","type":"unknown","description":"JSON Schema defining the expected input for task runs."}
{"stackTrail":"components:schemas:CreateTaskRequest:properties:output_schema","oasType":"schema","type":"unknown","description":"JSON Schema defining the expected output for task runs."}
promptstring nullable

Instructions for the agent describing what this task should do.

{"stackTrail":"components:schemas:CreateTaskRequest:properties:storage","oasType":"schema","type":"unknown","description":"Storage configuration for file capture. Set `enabled` to `true` to capture files. Supports `enabled`, `extraction`, `extraction_schema`, `extraction_prompt`, `deduplication`, and `deduplication_schema` fields."}

Response

Created

idstring required

Unique identifier for the task, prefixed with task_.

objectstring required

Always task.

namestring required

Display name for the task.

promptstring nullable required

Instructions for the agent describing what this task should do.

statusstring required

Task status: learning, test, or live.

agent_idstring required

The agent this task belongs to. Prefixed with agt_.

{"stackTrail":"components:schemas:JsonElement","oasType":"schema","type":"unknown","description":"Arbitrary JSON value."}
{"stackTrail":"components:schemas:JsonElement","oasType":"schema","type":"unknown","description":"Arbitrary JSON value."}
{"stackTrail":"components:schemas:JsonElement","oasType":"schema","type":"unknown","description":"Arbitrary JSON value."}
{"stackTrail":"components:schemas:JsonElement","oasType":"schema","type":"unknown","description":"Arbitrary JSON value."}
created_atstring date-time required

ISO 8601 timestamp of when the resource was created.

updated_atstring date-time required

ISO 8601 timestamp of when the resource was last updated.

request_idstring required

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

Changes