v3
latestOpenAPI 3.1.02026-08-0431146.5 KBStream progress for a background research task
Stream real-time progress for a background research task using Server-Sent Events (SSE). The stream starts with a connected event, followed by periodic ping comments to keep the connection alive, and closes when the task reaches a terminal status (completed, failed, or cancelled), at which point a terminal event matching the status name is sent. 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.
get/v1/research/{task_id}/stream
Path parameters
task_idstring uuid required
The unique identifier of the background research task.
Query parameters
from_idinteger
Optional event ID to replay events from after reconnecting.
Response
A Server-Sent Events stream of task progress updates.