GET /v1/usage
Updated
What does GET /v1/usage do?
Your recent row consumption and the rows left in your monthly quota. Returns your own recent usage: rows billed per day over the recent window, and the rows remaining in your monthly quota. Use it to watch spend and to reconcile against your own call log.
The agent rail and the /v1 endpoints debit the same monthly row quota, so this figure is the whole account’s consumption, however the rows were read.
Authentication
API key required. Set $BF to the API base and pass your key in $BLACKFORGE_API_KEY.
Parameters
None. GET /v1/usage takes no query parameters.
Example request
curl -H "x-api-key: $BLACKFORGE_API_KEY" \
"$BF/v1/usage"Example response
{
"days": [
{
"date": "2026-08-23",
"count": 47,
"lastAt": "2026-08-23T05:47:14.609Z"
},
{
"date": "2026-08-22",
"count": 47,
"lastAt": "2026-08-22T05:44:21.780Z"
},
{
"date": "2026-08-21",
"count": 47,
"lastAt": "2026-08-21T05:49:49.592Z"
}
],
"rowsRemaining": 499947908
}Returns
A JSON object with a days array (each day’s date, row count and last-call time) and rowsRemaining, the rows left in the monthly quota.
Responses and errors
| Status | When |
|---|---|
401 | The x-api-key header is missing or not a valid key. |