Skip to main content
GET
/
v1
/
batches
/
{batch_id}
Get Batch Endpoint
curl --request GET \
  --url https://api.extract.page/v1/batches/{batch_id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "<string>",
  "status": "<string>",
  "counts": {
    "pending": 0,
    "running": 0,
    "succeeded": 0,
    "failed": 0,
    "cancelled": 0
  },
  "total_items": 123,
  "engine": "<string>",
  "options": {},
  "created_at": "<string>",
  "expires_at": "<string>",
  "items": [
    {
      "id": "<string>",
      "batch_id": "<string>",
      "file_id": "<string>",
      "position": 123,
      "status": "<string>",
      "attempts": 123,
      "updated_at": "<string>",
      "object": "batch_item",
      "page_count": 123,
      "started_at": "<string>",
      "completed_at": "<string>",
      "result_url": "<string>",
      "error": {}
    }
  ],
  "object": "batch",
  "metadata": {},
  "started_at": "<string>",
  "completed_at": "<string>",
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.extract.page/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-KEY
string
header
required

Path Parameters

batch_id
string
required

Query Parameters

cursor
string | null
limit
integer
default:100
Required range: 1 <= x <= 500

Response

Successful Response

id
string
required
status
string
required
counts
BatchCounts · object
required
total_items
integer
required
engine
string | null
required
options
Options · object
required
created_at
string
required
expires_at
string
required
items
BatchItemResource · object[]
required
object
string
default:batch
metadata
Metadata · object
started_at
string | null
completed_at
string | null
next_cursor
string | null