Skip to content
easting.aidocs

Search is only available in production builds. Try building and previewing the site to test it out locally.

This month's document count and token totals

GET
/v1/usage
curl --request GET \
  --url 'https://example.com/v1/usage?prefix=east_live_AbCdEfGh' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
prefix
Any of:
string

Report on one of your other keys instead of this one. A customer running a key per environment attributes spend this way. Only keys owned by the same account are visible; anything else is a 404, never a hint that the key exists.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
UsageResponse
object
key
required
Key
string
name
required
Name
string
monthly_cap
required
Monthly Cap

Hard ceiling. For a subscribed key this is above included_docs and exists to catch runaway usage, not to be reached.

integer
included_docs
Any of:
integer
overage_documents
Overage Documents

Documents this month beyond included_docs, billed per document.

integer
0
documents
required
Documents
integer
input_tokens
required
Input Tokens
integer
output_tokens
required
Output Tokens
integer
period_start
required
Period Start
string format: date-time
period_end
required
Period End
string format: date-time
Example
{
  "documents": 47,
  "included_docs": 100,
  "input_tokens": 341902,
  "key": "east_live_AbCdEfGh",
  "monthly_cap": 300,
  "name": "Acme Surveying",
  "output_tokens": 58311,
  "overage_documents": 0,
  "period_end": "2026-08-01",
  "period_start": "2026-07-01"
}

401

Section titled “401”

Missing, unknown, or revoked API key

Media typeapplication/json
ErrorResponse
object
error
required
ErrorDetail
object
type
required
Type
string
message
required
Message
string
key
additional properties
any
Example
{
  "error": {
    "documents_used": 200,
    "message": "Monthly document quota reached: 200 of 200 documents used this month. The cap resets on 2026-08-01. Email sales@easting.ai to raise it.",
    "monthly_cap": 200,
    "resets_on": "2026-08-01",
    "type": "quota_exceeded"
  }
}

404

Section titled “404”

No such resource under this caller

Media typeapplication/json
ErrorResponse
object
error
required
ErrorDetail
object
type
required
Type
string
message
required
Message
string
key
additional properties
any
Example
{
  "error": {
    "documents_used": 200,
    "message": "Monthly document quota reached: 200 of 200 documents used this month. The cap resets on 2026-08-01. Email sales@easting.ai to raise it.",
    "monthly_cap": 200,
    "resets_on": "2026-08-01",
    "type": "quota_exceeded"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}