Add URLs to an open batch job
spicrawl_batch_add_itemsAppend URLs to a batch job that was submitted with open: true. Same item vocabulary as spicrawl_batch_submit (EITHER urls or items, not both, plus shared settings for these new items). Fails with CONFLICT if the job is closed or finished. Not idempotent: calling twice adds the URLs twice. Returns { job, items_added, items_dispatched }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| urls | No | Shorthand: URLs scraped with the shared settings and no per-item overrides. Mutually exclusive with `items`. | |
| wait | No | Milliseconds to wait after load (rendered scrapes). | |
| items | No | Long form: one /v1/scrape request object per item. Besides `url` and `external_id`, any /v1/scrape field (e.g. `js_render`, `wait_for`, `response_format`) overrides the shared setting for that item only. Mutually exclusive with `urls`. | |
| engine | No | Pin the scrape engine for every item: `fetch` or `obscura` (must be allowed by the plan and served by the deployment); `camoufox` is coming soon, do not pin it yet. `chromium` cannot be pinned in a batch — use `render: true`, or spicrawl_scrape. | |
| format | No | Output format for every item (`response_format`). spicrawl_batch_submit defaults to 'markdown', the same as spicrawl_scrape; an item's own `response_format` overrides it. | |
| job_id | Yes | The batch job id returned by spicrawl_batch_submit or spicrawl_batch_list. | |
| render | No | Render every URL with a browser (`js_render`). | |
| max_cost | No | Ceiling in credits for ONE item (not the whole job — see credit_budget). | |
| wait_for | No | CSS selector to wait for before capturing (rendered scrapes). | |
| premium_proxy | No | Coming soon: not available yet, do not send. Use residential managed-pool exits for every URL. | |
| proxy_country | No | Coming soon: not available yet, do not send. ISO-3166 alpha-2 exit country; requires premium_proxy. | |
| custom_headers | No | Extra request headers sent with every URL. | |
| block_resources | No | Resource types to block while rendering, e.g. ["image","font","media"]. | |
| main_content_only | No | Strip each page to its main article. |