stream_task
Opens a persistent SSE connection that emits events as the task progresses. The stream closes automatically when the task reaches a terminal state or after ~90 seconds (timeout). Heartbeat comments are sent every ~15 seconds to keep the connection alive through proxies.
Event types:
status— emitted when status changes (pending → running → complete/failed)result— emitted oncompletewith the full result payloaderror— emitted onfailed,cancelled, orexpiredwith error infoSSE comment (
: heartbeat) — keepalive, no data
Use this tool when:
You want real-time progress without polling.
You are in an environment that supports SSE (EventSource API).
Do NOT use this tool when:
You want a simple one-shot status check — use
get_taskinstead.Your HTTP client doesn't support streaming responses.
Inputs:
task_id(path, required): 26-char ULID.
Returns:
SSE stream (
text/event-stream). Each event isevent: <type>\\ndata: <json>\\n\\n.
Cost:
Free. Counts as one request against rate limits when the stream opens.
Latency:
First event: <200ms. Stream duration: up to 90s.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | Yes |