API reference sections
Schema
UsageResponse
Type object
Shape
| Field | Type | Description |
|---|---|---|
| reportrequired | UsageReport |
{
"report": {
"chat_id": "00000000-0000-4000-8000-000000000000",
"current_chat": {
"attempts": 0,
"attempts_with_reported_usage": 0,
"request_payload_bytes": 0,
"web_search_calls": 0,
"context_payload_bytes": 0,
"message_count": 0,
"context_document_count": 0,
"context_message_block_count": 0,
"prompt_tokens": 0,
"cached_prompt_tokens": 0,
"completion_tokens": 0,
"reasoning_tokens": 0,
"total_tokens": 0,
"average_context_assembly_ms": 0,
"average_provider_start_ms": 0,
"average_time_to_first_token_ms": 0,
"average_generation_ms": 0,
"average_total_ms": 0,
"good_feedback": 0,
"bad_feedback": 0
},
"groups": [
{
"utc_day": "string",
"surface": "standalone",
"provider": "string",
"model": "string",
"reasoning": "default",
"status": "pending",
"prompt_template_version": "string",
"totals": {
"attempts": 0,
"attempts_with_reported_usage": 0,
"request_payload_bytes": 0,
"web_search_calls": 0,
"context_payload_bytes": 0,
"message_count": 0,
"context_document_count": 0,
"context_message_block_count": 0,
"prompt_tokens": 0,
"cached_prompt_tokens": 0,
"completion_tokens": 0,
"reasoning_tokens": 0,
"total_tokens": 0,
"average_context_assembly_ms": 0,
"average_provider_start_ms": 0,
"average_time_to_first_token_ms": 0,
"average_generation_ms": 0,
"average_total_ms": 0,
"good_feedback": 0,
"bad_feedback": 0
}
}
]
}
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Used by
GET
Read private local AI usage/v1/ai/usageGET
Read current-chat and all private local AI usage/v1/ai/chats/{chat}/usage
Generated from contract version 1. Last updated .
