Batch

Append items to an open job

Adds items to a job created with open: true. Same body shape as batchCreate: urls or items, at most 10,000 per call; a job holds at most 100,000 items across all appends (exceeding it is a 400). New items get seq numbers continuing from the job's current total. Only per-item values are stored: a new item runs with the job's ORIGINAL job-level parameters plus its own overrides. Top-level scrape parameters in this body are used only to validate the new items and are otherwise discarded; run controls (name, concurrency, priority, max_attempts, failure_threshold, credit_budget, webhook_endpoint_id, open) are accepted and ignored. Appended items are held against the monthly allowance exactly like submitted ones (402 if it cannot cover them, and then nothing is added); estimated_credits stays the submission's and is not updated. 409 when the job is closed (never opened, or already closed). When finished appending, call POST /v1/batch/{batchID}/close.

post/v1/batch/{batchID}/items

Request

  • Base URL: https://api.spicrawl.com
  • URL: https://api.spicrawl.com/v1/batch/{batchID}/items
  • Auth: HTTP bearer

Request body

methodMethod (unresolved $ref)
js_renderJsRender (unresolved $ref)
stealthStealth (unresolved $ref)
impersonateImpersonate (unresolved $ref)
modeMode (unresolved $ref)
engineEngine (unresolved $ref)
premium_proxyPremiumProxy (unresolved $ref)
proxy_countryProxyCountry (unresolved $ref)
proxyProxy (unresolved $ref)
proxy_verifyProxyVerify (unresolved $ref)
session_idSessionId (unresolved $ref)
sticky_keyStickyKey (unresolved $ref)
waitWait (unresolved $ref)
wait_forWaitFor (unresolved $ref)
wait_for_timeoutWaitForTimeout (unresolved $ref)
actionsActions (unresolved $ref)
block_resourcesBlockResources (unresolved $ref)
headlessHeadless (unresolved $ref)
screenshotScreenshot (unresolved $ref)
screenshot_fullpageScreenshotFullpage (unresolved $ref)
screenshot_selectorScreenshotSelector (unresolved $ref)
screenshot_formatScreenshotFormat (unresolved $ref)
screenshot_qualityScreenshotQuality (unresolved $ref)
custom_headersCustomHeaders (unresolved $ref)
autoparseAutoparse (unresolved $ref)
linksLinks (unresolved $ref)
network_captureNetworkCapture (unresolved $ref)
extractExtract (unresolved $ref)
extract_presetExtractPreset (unresolved $ref)
ai_extractAiExtract (unresolved $ref)
main_content_onlyMainContentOnly (unresolved $ref)
include_tagsIncludeTags (unresolved $ref)
exclude_tagsExcludeTags (unresolved $ref)
parse_pdfParsePdf (unresolved $ref)
response_formatResponseFormat (unresolved $ref)
cacheCache (unresolved $ref)
cache_ttlCacheTtl (unresolved $ref)
max_costMaxCost (unresolved $ref)
original_statusOriginalStatus (unresolved $ref)
allowed_status_codesAllowedStatusCodes (unresolved $ref)

Response

Items written. If items_dispatched < items_added the remainder is recovered by the worker's sweep; do NOT re-append them (they would run twice).

items_addedinteger required

Items written to the job. Their seq values continue from the previous total_items.

items_dispatchedinteger required

Of those, how many reached the dispatch queue now. The rest are recovered by the worker's sweep; do not re-append them.

Example response

{
  "job": {
    "id": "01J9Z6T3W9E21T5TZARVJRVN5C",
    "project_id": "01J8X2M4C7Q1H5V9P3R6T8W0YB",
    "name": "catalog-2026-09-22",
    "status": "running",
    "status_url": "/v1/batch/01J9Z6T3W9E21T5TZARVJRVN5C",
    "results_url": "/v1/batch/01J9Z6T3W9E21T5TZARVJRVN5C/results",
    "params": {
      "js_render": true,
      "proxy_country": "us",
      "credit_budget_micro": 8000000
    },
    "total_items": 2,
    "concurrency": 20,
    "priority": 100,
    "max_attempts": 3,
    "estimated_credits": 8,
    "estimated_credits_micro": 8000000,
    "progress": {
      "total": 2,
      "completed": 1,
      "succeeded": 1,
      "failed": 0,
      "cancelled": 0,
      "skipped": 0,
      "remaining": 1,
      "percent_complete": 50,
      "credits_charged": 4,
      "credits_charged_micro": 4000000,
      "bytes": 326000
    },
    "submitted_at": "2026-09-22T06:41:12Z",
    "started_at": "2026-09-22T06:41:13Z",
    "results_expire_at": "2026-09-25T06:41:12Z"
  }
}

Changes

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