Sign in

v19

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

Retrieve Task Group Run

Retrieves run status by run_id.

This endpoint is equivalent to fetching run status directly using the retrieve() method or the tasks/runs GET endpoint.

The run result is available from the /result endpoint.

get/v1/tasks/groups/{taskgroup_id}/runs/{run_id}

Path parameters

taskgroup_idstring required
run_idstring required

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"
}