Sign in

v19

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-084091267.1 KB
Tasks

Create Task Run

Initiates a task run.

Returns immediately with a run object in status 'queued'.

Beta features can be enabled by setting the 'parallel-beta' header.

post/v1/tasks/runs

Headers

parallel-betastring nullable

Request body

processorstring required

Processor to use for the task.

metadataobject nullable

User-provided metadata stored with the run. Keys and values must be strings with a maximum length of 16 and 512 characters respectively.

previous_interaction_idstring nullable

Interaction ID to use as context for this request.

enable_eventsboolean nullable

Controls tracking of task run execution progress. When set to true, progress events are recorded and can be accessed via the Task Run events endpoint. When false, no progress events are tracked. Note that progress tracking cannot be enabled after a run has been created. The flag is set to true by default for premium processors (pro and above).

Example request

{
  "processor": "base",
  "source_policy": {
    "include_domains": [
      "wikipedia.org",
      "usa.gov",
      ".edu"
    ],
    "exclude_domains": [
      "reddit.com",
      "x.com",
      ".ai"
    ],
    "after_date": "2024-01-01"
  },
  "advanced_settings": {
    "location": "us"
  },
  "task_spec": {
    "output_schema": {
      "json_schema": {
        "additionalProperties": false,
        "properties": {
          "gdp": {
            "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
            "type": "string"
          }
        },
        "required": [
          "gdp"
        ],
        "type": "object"
      }
    },
    "input_schema": {
      "json_schema": {
        "additionalProperties": false,
        "properties": {
          "gdp": {
            "description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
            "type": "string"
          }
        },
        "required": [
          "gdp"
        ],
        "type": "object"
      }
    }
  }
}

Response

Successful Response

run_idstring required

ID of the task run.

interaction_idstring required

Identifier for this interaction. Pass this value as previous_interaction_id to reuse context for a future request.

status'queued' | 'action_required' | 'running' | 'completed' | 'failed' | 'cancelling' | 'cancelled' required

Status of the run.

is_activeboolean required

Whether the run is currently active, i.e. status is one of {'cancelling', 'queued', 'running'}.

processorstring required

Processor used for the run.

metadataobject nullable

User-provided metadata stored with the run.

taskgroup_idstring nullable

ID of the taskgroup to which the run belongs.

created_atstring nullable required

Timestamp of the creation of the task, as an RFC 3339 string.

modified_atstring nullable required

Timestamp of the last modification to the task, as an RFC 3339 string.

Example response

{
  "run_id": "trun_e0083b6aac0544eb8686e8d2a76533d2",
  "interaction_id": "trun_e0083b6aac0544eb8686e8d2a76533d2",
  "status": "queued",
  "warnings": [],
  "processor": "base",
  "metadata": {},
  "created_at": "2025-04-24T18:56:22.513132Z",
  "modified_at": "2025-04-24T18:56:22.513132Z"
}