Start a Batch Job

Queue a batch of URLs for asynchronous extraction

Authorization

APIKeyHeader

X-Api-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

urls*array<string>

URLs to extract in one batch

ignore_invalid_urls?Ignore Invalid Urls

If true, invalid URLs are skipped and returned in invalid_urls instead of failing the request

formats?array<>

Output formats to return

render_js?Render Js

If true, uses a headless browser to render the page for every batch item

proxy?

Proxy configuration

headers?|

Custom HTTP headers to include in extraction requests

wait_config?|

Grouped browser wait policy applied to every batch item. Optional — when omitted or explicitly null, each child extraction uses the adaptive default settle policy whenever a browser runs. Send an object to opt every child extraction into caller-owned explicit wait mode, which skips the adaptive default settle phase. Only non-null wait_config values count as provided; null fields inside wait_config behave the same as absence. If render_js is not set explicitly, any non-null wait_config value auto-enables browser rendering for the workflow and the effective render_js value is returned in batch_config. If you explicitly send render_js=false together with non-null wait_config values, the request is rejected as ambiguous.

Response Body

`application/json`

curl -X POST "https://example.com/v1/batch" \  -H "Content-Type: application/json" \  -d '{    "urls": [      "string"    ]  }'

{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "status": "queued",
  "status_url": "string",
  "accepted_urls": 0,
  "invalid_urls": [
    "string"
  ]
}

Empty

Start a Batch Job

Authorization

Request Body

Response Body

202application/json

401

422

429

503

`application/json`