Sign in

v2

latestOpenAPI 3.1.02026-07-263761369.4 KB
usage

Get usage

Get organization usage totals, user breakdowns, and the paginated thread activity timeline shown in the usage dashboard. Monetary amounts are decimal US dollar numbers.

get/v1/usage

Query parameters

orgIdstring required
fromstring date-time required
tostring date-time required
routed'paid' | 'no_cost' | 'oss' | 'external_copilot' | 'external_codex' | 'external_byok' | 'external_azure' | 'external_unknown' | 'external_xai' | 'all'
userIdstring
projectIdsstring

Comma-separated project IDs to include.

agentType'build' | 'captain' | 'review'

Filter usage to build, captain, or review activity.

sortBy'lastActivity' | 'cost' | 'name' | 'diff' | 'owner'
sortDirection'asc' | 'desc'
pageinteger
pageSizeinteger

Response

Success

orgIdstring required
fromstring required
tostring required
currency'USD' required
routed'paid' | 'no_cost' | 'oss' | 'external_copilot' | 'external_codex' | 'external_byok' | 'external_azure' | 'external_unknown' | 'external_xai' | 'all' required
totalinteger required
pageinteger required
pageSizeinteger required
totalPagesinteger required