Skip to content
easting.aidocs

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

Replace one key with a successor

POST
/v1/keys/{prefix}/rotate
curl --request POST \
  --url https://example.com/v1/keys/example/rotate \
  --header 'Authorization: Bearer <token>'

Same name, same caps, same owner, new secret, old one revoked, in one transaction. A rotated key that came back unowned would vanish from this list at the one moment its owner is looking at it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
prefix
required
Prefix
string

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

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

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