Sign in

v2

OpenAPI 3.1.02026-07-313534.7 KB

Get the status of a background research task

Poll the status of a background research task created with background=true. When the task is completed, the result is included in the response.

get/v1/research/{task_id}

Path parameters

task_idstring uuid required

The UUID of the research task.

Response

The task status and, when complete, the result.

idstring uuid required

Unique identifier for the task.

task_typestring required

Task type.

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

Current status of the task.

created_atstring date-time required

When the task was created.

updated_atstring date-time required

When the task was last updated.

completed_atstring date-time nullable

When the task completed, if applicable.

errorstring nullable

Error message if the task failed.

inputobject nullable

The original request input for the task.

resultobject nullable

The task result when completed. For research tasks, this contains the ResearchResponse output.

Example response

{
  "task_type": "research"
}