API ReferenceUsage

Get usage statistics

GET
/api/v1/usage

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication. Include your API key in the Authorization header as Bearer rf_your_key.

In: header

Query Parameters

period?string

Time period for usage summary

Default"month"
Value in"day" | "week" | "month" | "year"

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:8080/api/v1/usage"
{
  "byok_jobs": 0,
  "total_charged_usd": 0.1,
  "total_jobs": 0
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}