Batch

Submit up to 100 independent capture requests

Requires the Business plan or higher. A Pro or Hobby key receives 403 with code PLAN_FEATURE_UNAVAILABLE and an upgrade_url. Business and Enterprise keys can submit normally; when the deployment-wide product emergency pause is active, they receive 403 FEATURE_NOT_ENABLED without an upgrade_url and GET /credits reports capabilities.routes["/batch"].reason as platform. This route is not billed, but the gates still apply: "free" means no credit is charged, not that every account may call it.

Each item becomes a bounded child job. Results are aggregated through the returned parent job.

One parent workflow at a time. A single API key may have only one batch or crawl active (pending, processing, retrying, or cancel_requested). A second submission while one is running is refused with 409 and code WORKFLOW_ALREADY_ACTIVE, and the response's existingJobId names the blocking job. Recover by polling that job until it reaches a terminal state, or by cancelling it with DELETE. The limit is per API key, so separate keys on the same account run independently. Note that a submission which times out at the gateway may still be running: the work continues server-side, so a 504 on submit can be followed by this 409 on the next attempt even though nothing looks active from the caller's side.

post/batch

Request

  • Base URL: https://api.domscout.io
  • URL: https://api.domscout.io/batch
  • Auth: API key in header x-api-key

Headers

Idempotency-Keystring

Optional caller-generated key for POST submission. Reusing a key with an identical body for the same owner returns the original job; reusing it with a different body returns 409.

Request body

BatchRequest required(unresolved $ref)

Response

Idempotent replay of a batch workflow that has already reached a terminal state (done, error, or cancelled). The body carries replayed:true and the final counts. A replay of a workflow that is still running returns 202 instead.

status'accepted' | 'pending' | 'processing' | 'retrying' | 'done' | 'error' | 'cancel_requested' | 'cancelled' required
jobIdstring uuid required
pollUrlstring required
kind'batch' | 'crawl' required
createdAtstring date-time
messagestring
replayedboolean

Present and true when an Idempotency-Key matched an existing workflow and this response replays it rather than creating a new one.

Changes

No recorded changes to this operation across all 1 revision of this API.