Skip to main content
POST
Add URLs to an open job

Authorizations

X-API-Key
string
header
required

Batch, Crawl, the Extract endpoints and the account endpoint read the same key from the X-API-Key header.

Headers

Idempotency-Key
string

Optional opaque token scoping a single submit / rerun / add-tasks request, kept for 24 hours. A retry with the same key and the same body replays the original status and body. The same key with a different body, or while the original request is still being processed, returns 409 idempotency_key_conflict. A request that is refused (any 4xx, or a 503 before the job or run was created) gives the key back, so a retry with the same key is processed afresh. A 503 after the job or run was created keeps the key: a retry under it is 409; check the job before you resend with a fresh key. On add-tasks a retry with the same body finishes an attempt that stopped partway and adds each task once. The credit check runs first, so a retry of a call that succeeded returns 402 if the account has run out of credit since. At most 128 characters; a longer key is 400 invalid_argument.

Maximum string length: 128

Path Parameters

job_id
string
required

Assigned by the server on submit.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
tasks
object[]
required

1 to 10,000 tasks per call by default (an account can have its own limit). An open job's run holds at most 100,000 tasks in total; going over returns 429 quota_exceeded.

Minimum array length: 1
last_batch
boolean
default:false

Set true on the final batch. Closes the job (status → closed) and marks the run's last_batch_received.

Response

Tasks queued.

accepted_tasks
integer
required
job_status
enum<string>
required
  • open: initial run still accepting addBatchTasks. Only meaningful while latest_run.run_sequence == 1.
  • closed: no more tasks accepted (created closed, or closed via /close / addTasks{last_batch} / /rerun).
  • deleted: never returned. A deleted job disappears from every read and list the moment DELETE is accepted (reads answer 404); its data is cleaned up asynchronously after.

Clients must accept values not listed here.

Available options:
open,
closed,
deleted
latest_run
object
required