Stream Message — POST /api/v1/chat/sessions/{session_id}/messages/stream
Stream Message
Ask a question and receive the answer as server-sent events.
Endpoint: POST /api/v1/chat/sessions/{session_id}/messages/stream
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- You must have access to this session.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”| Content type | Body | Required |
|---|---|---|
application/json | StreamMessageRequest | yes |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | Not documented (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Response fields not documented. The API specification does not describe the body of every response this endpoint returns, so this page cannot list those fields. The body is not empty. To see it, call the endpoint on your own installation. All endpoints with undocumented responses.
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Chat
- Operation ID:
stream_message_api_v1_chat_sessions__session_id__messages_stream_post - Source code:
backend/app/routers/chat.py, line 182 - Specification: OpenAPI JSON