Hosted platformREST API reference
Assistant
The support assistant: answers product questions from the documentation through the platform's own models with cited sources, keeps the conversation and hands over a ticket draft when a person is needed; no API key required.
Hosted platformAPI version 2.1.0
post
Chat
Ask the assistant. Plain JSON by default; stream: true answers as server-sent events (meta with the
conversation id, delta per token, done with the same JSON the plain call returns).
Requires an API key
Request bodyChatIn
| Field | Type | Default | Description |
|---|---|---|---|
| conversation_id | string | null | ||
| message(required) | string | ||
| page | string | null | ||
| stream | boolean | false |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
| 401 | Missing, invalid or revoked API key |
Requestbash
curl -s -X POST "$OSR_URL/api/v1/assistant/chat" \
-H "Authorization: Bearer $OSR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "message": "string" }'Bodyjson
{
"message": "string"
}get
Conversation
Requires an API key
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| conversation_id(required) | path | string |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
| 401 | Missing, invalid or revoked API key |
Requestbash
curl -s "$OSR_URL/api/v1/assistant/conversations/<conversation_id>" \
-H "Authorization: Bearer $OSR_API_KEY"get
Kb Search
No authentication
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| q(required) | query | string | ||
| k | query | integer | 5 |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
Requestbash
curl -s "$OSR_URL/api/v1/assistant/kb/search?k=5"get
Status
Whether the assistant answers with a model or from the documentation alone, and how much it has indexed.
No authentication
Responses
| 200 | Successful Response |
Requestbash
curl -s "$OSR_URL/api/v1/assistant/status"Something wrong or out of date on this page? Tell us - the page is named for you, so a one-line note is enough.