Skip to content
Docs
Async jobs

Run a schedule now

Create one job from the schedule immediately, without changing the cadence. It is metered and delivered like any other async job. Free to submit; the items are charged as they run.

POST/v1/async/schedules/{schedule_id}/run
FreeAsync jobs, destinations, schedules and the callback secret are not changed from the docs; call this with your own key.

Request

POSThttps://api.scrapercompany.com/v1/async/schedules/{schedule_id}/run

Authenticate with your API key in the x-api-key header (see Authentication).

Parameters

  • schedule_idstringpathrequired

Example request

curl -X POST "https://api.scrapercompany.com/v1/async/schedules/asyncsched_0123456789abcdef0123456789abcdef/run" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY"

Response

202 — A job was created from the schedule; poll it.

202 response
{
  "id": "asyncjob_0123456789abcdef0123456789abcdef",
  "job_id": "asyncjob_0123456789abcdef0123456789abcdef",
  "status": "queued",
  "priority": 5,
  "status_url": "/v1/async/jobs/asyncjob_0123456789abcdef0123456789abcdef",
  "poll_url": "/v1/async/jobs/asyncjob_0123456789abcdef0123456789abcdef",
  "schedule_id": "asyncsched_0123456789abcdef0123456789abcdef",
  "destination_id": "asyncdst_0123456789abcdef0123456789abcdef",
  "delivery_status": "pending",
  "delivery_attempts": 0,
  "callback_status": "not_configured",
  "callback_attempts": 0,
  "meta": {
    "batch": "nightly"
  },
  "max_credits": 100,
  "credits_used": 0,
  "include_results": false,
  "items_total": 1,
  "items_succeeded": 0,
  "items_failed": 0,
  "created_at": "2026-10-22T10:00:01Z",
  "updated_at": "2026-10-22T10:00:01Z",
  "items": [
    {
      "id": "asyncitem_0123456789abcdef0123456789abcdef",
      "item_id": "asyncitem_0123456789abcdef0123456789abcdef",
      "index": 0,
      "operation": "POST /v1/calendar",
      "method": "POST",
      "path": "/v1/calendar",
      "label": "Boston Marriott Copley Place",
      "status": "queued",
      "attempts": 0,
      "credits": 0
    }
  ]
}

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

StatusMeaningRetry?
401Unauthorized

Missing or invalid API key.

{"detail":"missing or invalid API key"}		No, fix the request
404Not Found

The property, stay, job or record was not found.

{"detail":"job not found"}		No, fix the request
422Unprocessable Content

Request validation failed. detail is a list of problems for schema errors, or a string for semantic checks performed by the endpoint.

{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}		No, fix the request
429Too Many Requests

Too many requests: the key's requests-per-minute limit was exceeded, or (in enforce credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry.

{"detail":"rate limit 60/min exceeded"}		Yes, with backoff
503Service Unavailable

Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later.

{"detail":"database unavailable: OperationalError"}		Yes, with backoff

Try it

Async jobs, destinations, schedules and the callback secret are not changed from the docs; call this with your own key.

  1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
  2. Copy the cURL example above and run it in a terminal.

Questions about this page?

Send the page link and your question, and the team will answer.

Email support