Self-service usage, budget, and rate limit status

GoModel API reference for GET /v1/usage: Self-service usage, budget, and rate limit status.

GET {base_url}/v1/usage

Error

A valid request URL is required to generate request examples

200

{
  "budgets": [
    {
      "amount": 123,
      "exceeded": true,
      "per_child": true,
      "period_end": "<string>",
      "period_label": "<string>",
      "period_seconds": 123,
      "period_start": "<string>",
      "remaining": 123,
      "resets_in_seconds": 123,
      "scope": "<string>",
      "spent": 123,
      "subject": "<string>",
      "usage_ratio": 123,
      "user_path": "<string>"
    }
  ],
  "rate_limits": [
    {
      "exhausted": true,
      "in_flight": 123,
      "max_requests": 123,
      "max_tokens": 123,
      "per_child": true,
      "period_label": "<string>",
      "period_seconds": 123,
      "requests_remaining": 123,
      "requests_usage_ratio": 123,
      "requests_used": 123,
      "resets_in_seconds": 123,
      "subject": "<string>",
      "tokens_remaining": 123,
      "tokens_usage_ratio": 123,
      "tokens_used": 123,
      "user_path": "<string>",
      "window_end": "<string>",
      "window_start": "<string>"
    }
  ],
  "server_time": "<string>",
  "usage": {
    "cache_write_input_tokens": 123,
    "cached_input_tokens": 123,
    "end_date": "<string>",
    "rewrite_cost_saved": 123,
    "rewrite_tokens_saved": 123,
    "start_date": "<string>",
    "total_cost": 123,
    "total_input_cost": 123,
    "total_input_tokens": 123,
    "total_output_cost": 123,
    "total_output_tokens": 123,
    "total_requests": 123,
    "total_tokens": 123,
    "uncached_input_tokens": 123
  },
  "user_path": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date · string

Inclusive window start (YYYY-MM-DD, UTC); defaults to 29 days before end_date

end_date · string

Inclusive window end (YYYY-MM-DD, UTC); defaults to today; the whole range may span at most 365 days

days · integer

Window length ending today when no explicit dates are given (default 30, max 365)

Response

200

application/json

OK

budgets · object[]

Show child attributes

rate_limits · object[]

Show child attributes

server_time · string

usage · object

Show child attributes

user_path · string