Usage breakdown
The itemized record behind the total: who spent what, on which model, in which module.
Get usage totals
Consumption totalled over a period, for a bill or a budget. For the individual entries behind a total, read the usage entries.
query Parameters
pivotusage_detailsusage_paramusage_timestampusage_userHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get usage totals › Responses
Success
Get usage details
The individual entries making up one cell of the pivot, for tracing a number back to its source.
query Parameters
agent_idcursor^[A-Za-z0-9_-]+$limitoffsetprompt_idsort^-?[a-z0-9_]+$usage_detailsusage_paramusage_timestampusage_userHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get usage details › Responses
Success
List usage entries
Returns individual metered operations — what was run, by whom, and how many credits it consumed.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsort^-?[a-z0-9_]+$usage_detailsusage_paramusage_timestampusage_userHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List usage entries › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Get a usage pivot
Totals grouped both ways at once — by user and model, say — for a table rather than a list.
query Parameters
group_bytime_granularitytzusage_detailsusage_paramusage_timestampusage_userHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a usage pivot › Responses
Success