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

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

task_id
string
required

Unique identifier for the task (prefixed with task_).

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.

extraction
boolean
required

Whether document extraction is enabled for captured files.

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.