Skip to content

HTTP: usage

Default control-plane operations. Complete OpenAPI schema · Authentication and tenancy.

Get Usage Rollup

Aggregate usage-bearing events in a UTC-normalized half-open event-time window. Session filters apply to current session attributes. Totals remain exact when provider/model detail is bounded into an explicit remainder; callers may opt into a bounded per-session breakdown with its own exact remainder; cost is omitted from evaluation rather than reported partially when its price-input bound is exceeded. Scope is the configured session store; authentication does not add tenant filtering.

Operation ID: get_usage_rollup_api_usage_rollup_post.

{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageRollupRequest"
}
}
},
"required": true
}

Model declarations: UsageRollupRequest.

{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageRollupResponse"
}
}
}
},
"501": {
"description": "The configured store does not implement this aggregate read.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "A per-session identity cannot cross the configured redaction boundary.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"413": {
"description": "The usage-rollup request or serialized response exceeds its byte limit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "The configured store returned an inconsistent usage projection.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Model declarations: ApiErrorResponse, HTTPValidationError, UsageRollupResponse.