Research Task Status

View as MarkdownOpen in Claude

Retrieve the current status of a background research task. While the task is in progress, the result field is null. Once the task reaches completed, the full research result is returned in result. If the task fails, status is failed and error contains a diagnostic message.

Authentication

X-API-Keystring
A unique API Key is required to authorize API access. [Get your API Key with free credits](https://you.com/platform).

Path parameters

task_idstringRequiredformat: "uuid"
The unique identifier of the background research task.

Response

The current status and, if completed, the result of the task.
idstringformat: "uuid"
Unique identifier for the background research task.
task_typeenum
The task type.
statusenum
The status of a background research task.
created_atdatetime
When the task was created, in RFC 3339 format.
updated_atdatetime or null

When the task was last updated, in RFC 3339 format. null if the task has not yet started running.

completed_atdatetime or null

When the task reached a terminal status, in RFC 3339 format. null if the task has not yet completed, failed, or been cancelled.

errorstring or null

A diagnostic message when status is failed. null for all other statuses.

inputobject
The original request parameters submitted for the background research task.
resultobject or null

The final research result when status is completed. null while the task is queued or running.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error