Guides
Stream a response
Follow a task over Server-Sent Events and safely resume after a disconnect.
GET
/v1/tasks/{task_id}/events PreviewConnect with bearer authentication and accept text/event-stream:
curl -N "$OMNI_API_ORIGIN/v1/tasks/$OMNI_TASK_ID/events" \
-H "Authorization: Bearer $OMNI_API_KEY" \
-H "Accept: text/event-stream"Public event names are:
| Event | Meaning |
|---|---|
text_chunk | Incremental assistant text |
tool_start | A safely named tool began |
tool_end | A safely named tool completed or failed |
retrieval_citations | Validated public citations became available |
done | Terminal successful event |
error | Terminal stream error |
Record each SSE id. After a network interruption, reconnect with Last-Event-ID set to the last fully processed ID. The server resumes after that event; consumers must still tolerate duplicate delivery around network boundaries.
Never expect internal run IDs, raw tool arguments or results, provider request IDs, retrieval scores, or debug metadata in this stream.