Skip to main content
POST
/
v1
/
batches
Create Batch Endpoint
curl --request POST \
  --url https://api.extract.page/v1/batches \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "source": {
    "file_ids": [
      "<string>"
    ],
    "type": "files"
  },
  "engine": "<string>",
  "extract_text": true,
  "extract_images": true,
  "ocr": "auto",
  "metadata": {}
}
'
{
  "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>",
  "object": "batch",
  "metadata": {},
  "started_at": "<string>",
  "completed_at": "<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

Headers

Idempotency-Key
string | null

Body

application/json
source
FilesSource · object
required
engine
string | null
Maximum string length: 64
extract_text
boolean
default:true
extract_images
boolean
default:true
ocr
enum<string>
default:auto
Available options:
auto,
never,
force
metadata
Metadata · object

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
object
string
default:batch
metadata
Metadata · object
started_at
string | null
completed_at
string | null