u

docs/api/routes/modelconversation/_id/stream.md

@@ -0,0 +1,37 @@
+# `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 `message` events (persisted user/assistant messages), live `delta`
+text chunks of the model answer, and `state` events (`thinking`, `working`,
+`done`). The SSE states are not stored; the database only knows `idle`/`busy`.
+`done` carries `usage` (`input`, `cached`, `output`, `cost`) on success or
+`error` (string) 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 `message` 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`._