List the Usage events of the Organization
GET /v1/usage/events
| Property | Value |
|---|---|
| Operation | list_usage_events |
| Group | Usage |
| Scope | usage:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A metadata read; Usage events and the spend counter carry identifiers, units and amounts, never content. |
| Released in | 1.23.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Newest first, with keyset pagination and the filters call_id, stage, environment and a creation range (1.23.0, FR-usage-1), and from 1.63.0 origin and run_id, with which a client reads the evaluation usage of a run. An API key reads the events of its own environment only; a Member reads both. Each event's amount was rated once at finalize against the price list then in force and never changes.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the usage:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/usage/events" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/usage/events`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/usage/events",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | no | The page size, 1 to 100. |
cursor | query | string | no | The opaque next_cursor of the previous page; it binds the filters it was issued under. |
call_id | query | CallId | no | Only the events of this Call (1.23.0). |
stage | query | CostStage | no | Only the events of this stage (1.23.0). |
environment | query | Environment | no | Only the events of this environment (1.23.0). An API key reads its own environment only, so naming the other one answers an empty page; a Member reads both. |
created_after | query | RequestTimestamp | no | Only the events created at or after this instant (1.23.0); the start of the range is inclusive. |
created_before | query | RequestTimestamp | no | Only the events created before this instant (1.23.0); the end of the range is exclusive. |
origin | query | UsageEventOrigin | no | Only the events of this origin (1.63.0), such as evaluation; an event an api before 1.34.0 wrote has none and matches finalize. |
run_id | query | PromptEvalRunId | no | Only the evaluation events of this run (1.63.0). |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | UsageEventList | |
400 | application/json | ErrorEnvelope | invalid_request, invalid_cursor |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is UsageEventList.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of UsageEvent | yes | The Usage events of this page, newest first. |
has_more | boolean | yes | True when a further page exists. |
next_cursor | string or null | yes | The cursor of the next page, or null on the last page. |
object | "list" | yes |