VocalDocscontracts 1.65.0

List the Usage events of the Organization

GET /v1/usage/events

PropertyValue
Operationlist_usage_events
GroupUsage
Scopeusage:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A metadata read; Usage events and the spend counter carry identifiers, units and amounts, never content.
Released in1.23.0
Phase 0 hostServed (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"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
call_idqueryCallIdnoOnly the events of this Call (1.23.0).
stagequeryCostStagenoOnly the events of this stage (1.23.0).
environmentqueryEnvironmentnoOnly 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_afterqueryRequestTimestampnoOnly the events created at or after this instant (1.23.0); the start of the range is inclusive.
created_beforequeryRequestTimestampnoOnly the events created before this instant (1.23.0); the end of the range is exclusive.
originqueryUsageEventOriginnoOnly 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_idqueryPromptEvalRunIdnoOnly the evaluation events of this run (1.63.0).

Responses

StatusContent typeShapeError codes
200application/jsonUsageEventList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is UsageEventList.

FieldTypeRequiredDescription
dataarray of UsageEventyesThe Usage events of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes