Api referenceUsage
Assistant Usage
Reference for Assistant Usage in the Hyperoru v1 API, including request, response, and authentication details.
GET
/v1/workspaces/{workspace_id}/assistant/usageAssistant Usage. Returns a typed response and a request ID for operational support.
hyperoru_session<token>
Opaque HttpOnly customer session. Mutations also require X-CSRF-Token.
In: cookie
Path Parameters
workspace_id*Workspace Id
Format
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/assistant/usage"{
"active_user_runs": 0,
"active_workspace_runs": 0,
"cached_questions": 0,
"conversations": [
{
"cached_input_tokens": 0,
"cached_questions": 0,
"conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
"cost_usd": "string",
"input_tokens": 0,
"output_tokens": 0,
"questions": 0,
"title": "string"
}
],
"daily": [
{
"cached_questions": 0,
"cost_usd": "string",
"date": "string",
"questions": 0
}
],
"max_output_tokens": 0,
"monthly_cost_usd": "string",
"monthly_limit_usd": "string",
"period": "string",
"questions_today_user": 0,
"questions_today_workspace": 0,
"recent_runs": [
{
"cache_hit": true,
"cached_input_tokens": 0,
"conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
"cost_usd": "string",
"created_at": "2019-08-24T14:15:22Z",
"input_tokens": 0,
"output_tokens": 0,
"run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec"
}
],
"remaining_usd": "string",
"uncached_questions": 0,
"user_daily_limit": 0,
"workspace_daily_limit": 0
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}