Skip to content
easting.aidocs

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

Every key this account owns

GET
/v1/keys
curl --request GET \
  --url https://example.com/v1/keys \
  --header 'Authorization: Bearer <token>'

Revoked keys stay in the list on purpose: the credential someone retired last week is exactly the one they want to see when they are working out what is still live.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
KeyListResponse
object
keys
required
Keys
Array<object>
KeyRow

A key plus its month usage, for the admin listing.

object
prefix
required
Prefix
string
name
required
Name
string
monthly_cap
required
Monthly Cap
integer
created_at
required
Created At
string format: date-time
revoked_at
required
Any of:
string format: date-time
documents
required
Documents
integer
input_tokens
required
Input Tokens
integer
output_tokens
required
Output Tokens
integer
included_docs
Any of:
integer
pool_docs
Any of:
integer
lifetime_documents
Any of:
integer
user_id
Any of:
integer
grant_kind
Any of:
string
Examplegenerated
{
  "keys": [
    {
      "prefix": "example",
      "name": "example",
      "monthly_cap": 1,
      "created_at": "2026-04-15T12:00:00Z",
      "revoked_at": "2026-04-15T12:00:00Z",
      "documents": 1,
      "input_tokens": 1,
      "output_tokens": 1,
      "included_docs": 1,
      "pool_docs": 1,
      "lifetime_documents": 1,
      "user_id": 1,
      "grant_kind": "example"
    }
  ]
}

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"
  }
}

503

Section titled “503”

Extraction temporarily unavailable

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"
  }
}