Stream chat progress
Open a Server-Sent Events stream for durable message, activity, tool, and chat-state changes.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: messages:read.
GET /agents/{agent_id}/chats/{chat_id}/events
Open a Server-Sent Events stream for durable message, activity, tool, and chat-state changes.
| Parameter | Type | Description |
|---|---|---|
agent_idpath · required | string | Required agent_id path identifier. |
chat_idpath · required | string | Accessible chat ID. |
Acceptheader · required | text/event-stream | Requests an SSE stream. |
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/chats/$CHAT_ID/events" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY""id: 1842\nevent: message.completed\ndata: {\"message_id\":\"msg_01JA\",\"chat_id\":\"chat_01J8\",\"status\":\"completed\"}\n"Authorization
{
"type": "bearer",
"scope": "messages:read",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 401 | The workspace API key is missing, invalid, expired, or revoked. |
| 403 | The key lacks the required scope or its owner no longer has permission. |
| 404 | The resource is missing or intentionally hidden by authorization. |
| 429 | The key exceeded its current rate limit. |