Skip to content
easting.aidocs

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

Mint another key for this account

POST
/v1/keys
curl --request POST \
  --url https://example.com/v1/keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Nightly ETL" }'

The plaintext is shown once here and never stored, the same promise the claim page makes. There is no recovery path by design; there is a rotate button instead.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
UserKeyRequest

Minting a key for yourself. No caps here on purpose: a key is a credential against an entitlement you already have, so the plan’s numbers are copied rather than chosen, and a second key never buys a second allowance.

object
name
required
Name

What this credential is for. Shown in your key list and nowhere else.

string
>= 1 characters <= 200 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MintResponse
object
api_key
required
Api Key

Plaintext key. Shown once and never recoverable.

string
prefix
required
Prefix
string
name
required
Name
string
monthly_cap
required
Monthly Cap
integer
pool_docs
Any of:
integer
created_at
required
Created At
string format: date-time
Example
{
  "api_key": "east_live_AbCdEfGh1JkLmNoPqRsTuVwX",
  "created_at": "2026-07-30T18:24:57Z",
  "monthly_cap": 200,
  "name": "Acme Surveying",
  "prefix": "east_live_AbCdEfGh"
}

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

409

Section titled “409”

The request conflicts with current state

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": {}
    }
  ]
}

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