Skip to content

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

This key's recent batches

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

Successful Response

Media typeapplication/json
BatchListResponse
object
batches
required
Batches
Array<object>
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
{
"batches": [
{
"status": "in_progress",
"items": [
{
"status": "queued"
}
]
}
]
}

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