Research Task Stream

View as MarkdownOpen in Claude
Stream real-time progress for a background research task using Server-Sent Events (SSE). The stream starts with a `connected` event and closes when the task reaches a terminal status (`completed`, `failed`, or `cancelled`). To replay events after reconnecting, pass `?from_id=N` with the last event ID you received. After the stream closes, call `GET /v1/research/{task_id}` to retrieve the full `result` object.

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.

Query parameters

from_idintegerOptionalDefaults to 0
Optional event ID to replay events from after reconnecting.

Response

A Server-Sent Events stream of task progress updates.

Errors

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