Support
Help: support tickets (`/support/tickets` - raise a concern, get a reference such as `OSR-00042`, follow the conversation; every answer and status change is e-mailed to the requester) and the assistant.
Help: support tickets (`/support/tickets` - raise a concern, get a reference such as `OSR-00042`, follow the conversation; every answer and status change is e-mailed to the requester) and the assistant.
get/api/v1/support/tickets
List Tickets
The workspace's tickets, most recent activity first, with counts per status.
Requires an API key.
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| status | query | string | null | ||
| limit | query | integer | 100 |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
| 401 | Missing, invalid or revoked API key |
curl -s "$OSR_URL/api/v1/support/tickets?limit=100" \
-H "Authorization: Bearer $OSR_API_KEY"post/api/v1/support/tickets
Open Ticket
Raise a concern. Answers with the ticket and its reference; the requester is e-mailed the same.
Requires an API key.
Request bodyTicketIn
| Field | Type | Default | Description |
|---|---|---|---|
| body(required) | string | ||
| category | string | "question" | |
| priority | string | "normal" | |
| request_id | string | null | ||
| subject(required) | string |
Responses
| 201 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
| 401 | Missing, invalid or revoked API key |
curl -s -X POST "$OSR_URL/api/v1/support/tickets" \
-H "Authorization: Bearer $OSR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "body": "string", "subject": "string" }'{
"body": "string",
"subject": "string"
}get/api/v1/support/tickets/{key}
Get Ticket
One ticket by id or reference (`OSR-00042`) with its conversation (internal notes excluded).
Requires an API key.
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| key(required) | path | string |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
| 401 | Missing, invalid or revoked API key |
curl -s "$OSR_URL/api/v1/support/tickets/<key>" \
-H "Authorization: Bearer $OSR_API_KEY"post/api/v1/support/tickets/{key}/close
Close
The requester considers the matter closed.
Requires an API key.
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| key(required) | path | string |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
| 401 | Missing, invalid or revoked API key |
curl -s -X POST "$OSR_URL/api/v1/support/tickets/<key>/close" \
-H "Authorization: Bearer $OSR_API_KEY"post/api/v1/support/tickets/{key}/messages
Reply
Add to the conversation; an answered or resolved ticket goes back to `open`.
Requires an API key.
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| key(required) | path | string |
Request bodyMessageIn
| Field | Type | Default | Description |
|---|---|---|---|
| body(required) | string |
Responses
| 201 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
| 401 | Missing, invalid or revoked API key |
curl -s -X POST "$OSR_URL/api/v1/support/tickets/<key>/messages" \
-H "Authorization: Bearer $OSR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "body": "string" }'{
"body": "string"
}get/api/v1/support/tickets/{key}/stream
Stream
Live updates as server-sent events: the ticket with its conversation now, then again whenever it changes (a reply, a status change); a keep-alive comment every 15 s; ends after ten minutes (the client reconnects).
Requires an API key.
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| key(required) | path | string |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
| 401 | Missing, invalid or revoked API key |
curl -s "$OSR_URL/api/v1/support/tickets/<key>/stream" \
-H "Authorization: Bearer $OSR_API_KEY"