Events & Errors
Cortex uses durable run events for streaming execution state and a consistent error envelope for failed requests.
Run Events
| Event | Purpose |
|---|---|
run.progress | Human-readable progress update. |
message.stream.started | Assistant text stream started. |
message.stream.delta | Append text to the active assistant draft. |
message.created | Durable user or assistant message was persisted. |
tool.started / tool.completed | Tool-call status updates. |
document.created | A document or artifact is available. |
run.completed / run.failed / run.cancelled | Terminal run state. |
SSE Delivery
- Events include SSE
id,event, and JSONdata. - Clients should store the last sequence and reconnect with
?after=. - Keepalive comments should be ignored by parsers.
Error Envelope
{
"error": "Human-readable message",
"code": "OPTIONAL_MACHINE_CODE",
"details": { "field": "extra context" }
}