API referenceEndpointsUsage
usage.keys
RPC usage.keys · Scope read
AuthorizationBearer <token>
A Plane API key, pl_<env>_…. The key is the environment: everything it reads and writes is scoped to the environment it was minted in, and the two tenancy headers are ignored for one.
In: header
Header Parameters
x-plane-environment?string
The environment slug this request is about. Honoured only for a session cookie; ignored for an API key, whose environment is its identity.
x-plane-organization?string
The organization slug or id this request is about, resolved before the environment. Honoured only for a session cookie.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/usage/keys" \ -H "Content-Type: application/json" \ -d '{ "period": { "from": "string", "to": "string" } }'[ { "keyId": "string", "name": "string", "prefix": "string", "spend": { "agentMinutesPerMonth": 0, "tokensPerMonth": 0, "dailyUsd": 0 }, "revoked": true, "totals": { "activeSeconds": 0, "inputTokens": 0, "outputTokens": 0, "cacheReadTokens": 0, "cacheWriteTokens": 0, "cacheReportingCalls": 0, "serverToolRequests": 0, "turns": 0, "modelCalls": 0, "toolCalls": 0, "costUsd": 0, "unpricedCalls": 0 } }]