Skip to main content
GET
/
api
/
v1
/
usage
Get Usage
curl --request GET \
  --url https://api.example.com/api/v1/usage \
  --header 'Authorization: Bearer <token>'
{
  "plan": "<string>",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "tokens": {
    "used": 123,
    "limit": 123,
    "remaining": 123
  },
  "queries": {
    "used": 123,
    "limit": 123,
    "remaining": 123
  },
  "spaces": {
    "used": 123,
    "limit": 123,
    "remaining": 123
  },
  "rate_limit_rpm": 123,
  "rate_limit_per_day": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.crosmos.dev/llms.txt

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

Authorizations

Authorization
string
header
required

JWT access token or API key (csk_…)

Query Parameters

start_date
string<date> | null

Start date (defaults to 1st of current month)

end_date
string<date> | null

End date (defaults to today)

Response

Successful Response

Aggregated org-level usage and current plan limits.

plan
string
required
period_start
string<date>
required
period_end
string<date>
required
tokens
UsageMetric · object
required

Used / limit / remaining triple. -1 limit means unlimited.

queries
UsageMetric · object
required

Used / limit / remaining triple. -1 limit means unlimited.

spaces
UsageMetric · object
required

Used / limit / remaining triple. -1 limit means unlimited.

rate_limit_rpm
integer
required
rate_limit_per_day
integer
required