Skip to content
easting.aidocs

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

Submit one document for asynchronous extraction

POST
/v1/extracts
curl --request POST \
  --url https://example.com/v1/extracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/pdf' \
  --header 'X-Document-Name: citrus_fl_2025014130.pdf' \
  --data binary

Take the document, answer immediately, extract it elsewhere.

Use this for anything that might run long, which in practice is any multi-tract instrument. A small deed works here too and costs a couple of seconds of polling over the synchronous path.

The quota check happens now rather than when the worker finishes, so a job never settles into a bill the customer never agreed to. Jobs already in flight count against the allowance, batch items included.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Document-Name
Any of:
string

Filename to record and echo back.

X-Upload-Id
Any of:
string

A slot from POST /v1/uploads, for a document too big to send in one request. Send an empty body with it.

Request Body

Section titled “Request Body”

The document, exactly as /v1/extract takes it: raw bytes with an optional X-Document-Name, a multipart file part, or nothing at all when X-Upload-Id names a staged document.

string format: binary

Responses

Section titled “Responses”

202

Section titled “202”

Successful Response

Media typeapplication/json
ExtractJobSubmitResponse

What POST /v1/extracts answers, in milliseconds.

The extraction has not started yet. Poll poll_url until status is succeeded (the whole /v1/extract body arrives in result) or failed (the reason arrives in error).

object
job
required
Job
string
status
required
Status
string
Allowed values: queued running succeeded failed
document
required
Document
string
submitted_at
required
Submitted At
string format: date-time
poll_url
required
Poll Url

Poll here every few seconds until the status is terminal.

string
Example
{
  "document": "citrus_fl_2025014130.pdf",
  "job": "job_9dK2mQxLp7Zv",
  "poll_url": "https://api.easting.ai/v1/extracts/job_9dK2mQxLp7Zv",
  "status": "queued",
  "submitted_at": "2026-08-09T21:14:02Z"
}

400

Section titled “400”

The request was understood and refused

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

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

402

Section titled “402”

Monthly document cap or overage ceiling reached

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 job under this 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"
  }
}

410

Section titled “410”

Result past its retention window

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

413

Section titled “413”

Document over the size limit

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”

Body was empty, or was not a PDF, TIFF, PNG, or JPEG

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

429

Section titled “429”

Rate limited; read Retry-After

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

502

Section titled “502”

Extraction failed upstream

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