Skip to content
RAG API

Get usage and billing info

GET
/v1/usage

Returns the current billing period’s usage metrics, plan limits, and percentage consumed. The billing period is monthly, calculated from the account creation date anniversary.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Usage info retrieved

object
data
required
object
current_period_start
required

Start of the current billing period

string format: date-time
Example
2026-02-01T00:00:00.000Z
current_period_end
required

End of the current billing period

string format: date-time
Example
2026-03-01T00:00:00.000Z
plan
required
string
Allowed values: trial starter pro scale
Example
trial
limits
required
object
pages_processed
required

Maximum pages allowed in this billing period

integer
Example
1000
search_queries
required

Maximum search queries allowed in this billing period

integer
Example
5000
usage
required
object
pages_processed
required

Pages processed in this billing period

integer
Example
342
search_queries
required

Search queries made in this billing period

integer
Example
1205
percentage_consumed
required
object
pages
required

Percentage of page limit consumed (0-100+)

integer
Example
34
queries
required

Percentage of query limit consumed (0-100+)

integer
Example
24

401

Section titled “401 ”

Authentication failed or missing

object
error
required
object
code
required

Machine-readable error code

string
Allowed values: VALIDATION_ERROR AUTHENTICATION_ERROR NOT_FOUND CONFLICT RATE_LIMIT_EXCEEDED USAGE_LIMIT_EXCEEDED EXTERNAL_SERVICE_ERROR INTERNAL_ERROR
Example
VALIDATION_ERROR
message
required

Human-readable error message

string
Example
Invalid request body
details

Additional error details (e.g., validation issues)

object
key
additional properties
any
Example
{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

429

Section titled “429 ”

Rate limit exceeded

object
error
required
object
code
required

Machine-readable error code

string
Allowed values: VALIDATION_ERROR AUTHENTICATION_ERROR NOT_FOUND CONFLICT RATE_LIMIT_EXCEEDED USAGE_LIMIT_EXCEEDED EXTERNAL_SERVICE_ERROR INTERNAL_ERROR
Example
VALIDATION_ERROR
message
required

Human-readable error message

string
Example
Invalid request body
details

Additional error details (e.g., validation issues)

object
key
additional properties
any
Example
{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded"
  }
}