38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
# `GET /modelconversation/{id}/stream`
|
|
|
|
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
|
|
|
Stream conversation events (SSE)
|
|
|
|
Opens a Server-Sent Events stream for the specified conversation.
|
|
Streams live `delta` text chunks of the model answer, `usage` stats per turn,
|
|
and `state` events (`thinking`, `connected`, `firstevent`, `reasoning`,
|
|
`content`, `working`, `toolcall`, `done`). The SSE states are not stored;
|
|
the database only knows `idle`/`busy`.
|
|
`done` indicates generation has finished, carrying `error` (string) only if the run failed.
|
|
|
|
|
|
## Path parameters
|
|
|
|
| Param | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `id` | yes | integer | Conversation ID |
|
|
|
|
## Response `200`
|
|
|
|
SSE stream (`text/event-stream`). Emits `state`, `delta`, and `usage` events.
|
|
|
|
|
|
## Errors
|
|
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| 400 | Invalid ID or no company selected — `{"error":"…"}` |
|
|
| 401 | Unauthorized — `{"error":"…"}` |
|
|
| 403 | Not authorized — `{"error":"…"}` |
|
|
| 404 | Conversation not found — `{"error":"…"}` |
|
|
|
|
---
|
|
|
|
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|