Skip to main content
GET
/
api
/
v1
/
usage
Get usage summary
curl --request GET \
  --url http://localhost:3051/api/v1/usage \
  --header 'Authorization: Bearer <token>'
{
  "billing_period": "2023-12-25",
  "total_tokens": 123,
  "total_cost_usd": 123,
  "total_gpu_seconds": 123,
  "total_jobs": 123,
  "passed_jobs": 123,
  "rejected_jobs": 123,
  "daily": [
    {
      "date": "2023-12-25",
      "tokens": 123,
      "cost_usd": 123,
      "gpu_seconds": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.omnifence.ai/llms.txt

Use this file to discover all available pages before exploring further.

Requires the usage:read scope. Requests without this scope receive a 403 FORBIDDEN response. See authentication.

Authorizations

Authorization
string
header
required

API key from the Stars dashboard

Query Parameters

billing_period
string<date>

Response

200 - application/json

Default Response

billing_period
string<date>
required
total_tokens
integer
required
total_cost_usd
number
required
total_gpu_seconds
number
required
total_jobs
integer
required
passed_jobs
integer
required
rejected_jobs
integer
required
daily
object[]
required

Per-day usage breakdown within the billing period, ordered ascending by date.