Skip to content
easting.aidocs

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

Whether a batch has ended, and how its documents fared

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

Poll here. Answers over quota, the same way /v1/usage does: a customer who has hit their cap still needs to collect work already paid for.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
batch_id
required
Batch Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
BatchStatusResponse
object
batch
required
Batch
string
status
required
Status
string
Allowed values: in_progress ended failed
documents
required
Documents
integer
succeeded
required
Succeeded
integer
failed
required
Failed
integer
submitted_at
required
Submitted At
string format: date-time
completed_at
Any of:
string format: date-time
results_url
Any of:
string
items
Items
Array<object>
BatchItemSummary

One document inside a batch, without its result.

object
document
required
Document
string
status
required
Status
string
Allowed values: queued succeeded failed
error
Any of:
string
Example
{
  "status": "in_progress",
  "items": [
    {
      "status": "queued"
    }
  ]
}

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 batch 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 batch has not ended yet

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”

Results past their 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"
  }
}