VocalDocscontracts 1.65.0

Read the Organization's evaluation quota

GET /v1/usage/evaluation-quota

PropertyValue
Operationget_evaluation_quota
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.63.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Answers the Organization's evaluation quota of the current UTC day (1.63.0; prompt-manager.md section 9.1): the limit in model tokens, 2,000,000 a day (a target) until the plans of slice 2.5 carry it, the tokens of the Usage events of the origin evaluation used so far in every environment, the tokens the queued and running runs and calibrations hold, and what remains. A request that would pass it is refused with 429 evaluation_quota_reached.

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/evaluation-quota" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Responses

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

Fields of the 200 answer

The shape is EvaluationQuota.

FieldTypeRequiredDescription
limit_tokensintegeryesThe Organization's evaluation tokens a period: 2,000,000 (a target).
object"evaluation_quota"yes
periodEvaluationQuotaPeriodyes
period_startTimestampyes
remaining_tokensintegeryesThe limit less what is used and reserved, never below 0.
reserved_tokensintegeryesWhat the queued and running runs and calibrations hold, an estimate. Stated in 1.65.0, as the api built it: a queued live judgment holds no reservation; one that would pass the quota when it is claimed is skipped with evaluation_quota_reached.
resets_atTimestampyes
used_tokensintegeryesThe input and output tokens of the Usage events of the origin evaluation written in the period, every environment.