Skip to main content
GET
Get usage summary

Authorizations

Authorization
string
header
required

Your Reason API key from Settings › API keys. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, knowledge:read, memory:read, memory:write, skills:read, skills:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. network:read and network:write are opt-in, excluded from default keys. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

Query Parameters

start_date
string<date-time>

Beginning of the window. Omit it to start 30 days before end_date. A window longer than 92 days is cut to its latest 92 days.

end_date
string<date-time>

End of the window, excluded. Omit it, or pass a later time, to end the window now.

user_id
string<uuid>

Counts only this member's usage. Omit it for the whole workspace.

Response

Usage summary.

models
object[]
required

Usage per model, billing and provider, most tokens first.

agents
object[]
required

The same usage split by agent role: per role, model, billing and provider. Leads first, then helpers, each most tokens first.

machines
object[]
required

Cloud machine usage per rate and provider, longest running first.

totals
object
required

Totals over the window.

start_date
string<date-time>
required

Start of the window that was read.

end_date
string<date-time>
required

End of the window that was read.