# Run many requests (or one long one) as a job

Jobs

POST `/v1/jobs`

Runs up to `max_requests` (1000) endpoint requests in the background: each item is exactly the request its endpoint answers synchronously, at the same price (failed items are free), with the same caches. `max_pages` walks a list endpoint server-side with its cursor. Credits work as for synchronous requests: each page reserves its endpoint's minimum when it runs (against the balance and the calling key's spend limit) and is topped up to its price, so a job starts whenever its first page could run; `max_credits` (default: the sum of every item's maximum price) caps what the job may spend. With `wait`, the answer is 200 with the first page of results when the job ends in time (a synchronous batch), else 202 with the job; poll `GET /v1/jobs/{id}` (free) or subscribe to `job.completed`.

**Auth:** an API key with the `jobs` scope, or the dashboard session.

**Test mode:** A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.

Send an `idempotency-key` header to retry safely: the same key and body within 1 day never repeat the work.

## Example

cURL:

```shell
curl -X POST 'https://staging.socialtap.dev/v1/jobs' \
  -H "x-api-key: $SOCIALTAP_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "requests": [
    {
      "custom_id": "string",
      "endpoint": "facebook.search_ads",
      "params": {}
    }
  ]
}'
```

## Authorizations

`x-api-key`stringheaderrequired

Your API key, with the `jobs` scope. [Authentication](https://staging.socialtap.dev/docs/authentication/index.md)

## Headers

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `idempotency-key` optional | `string`<br>max 255 chars | On any POST: your unique key for the request (1–255 printable ASCII characters; a UUID is ideal), kept 24 hours. Retrying with the same key and body never repeats the work: the answer is the first request's result, in its current state. | — |

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `wait` optional | `integer`<br>min 0<br>max 60 | Seconds to wait for the job to end before answering. If it ends in time the answer is 200 with the first page of results (a synchronous batch); otherwise 202 with the job as it is. | — |

## Body

JSON. Fields marked nullable may be `null`; optional ones may be left out.

| Field | Type | Description |
| --- | --- | --- |
| `max_age?` | `integer` or `null` | Accept cached results up to this many seconds old for every item (free cache hits), like the endpoints' max_age. |
| `max_credits?` | `integer` or `null` | Most the job may spend: a cap, never held up front (each page reserves as a synchronous request does). Default: the sum of every item's maximum price (times its max_pages). Items that would go over it are canceled. |
| `metadata?` | `object` | Up to 16 string pairs of your own, returned with the job and in its events. |
| `requests` | `object[]` | The requests to run, 1 to 1000; custom_id must be unique within the job. |
| `requests[].custom_id` | `string` | Your ID for the item (letters, digits, _ and -), echoed on its results. |
| `requests[].endpoint` | `string` | The endpoint ID: Endpoint ID on its reference page, x-socialtap-endpoint in OpenAPI (youtube.transcript; not its operationId or path).<br>One of `facebook.search_ads`, `facebook.transcript`, `instagram.post`, `instagram.profile`, `instagram.transcript`, `tiktok.comments`, `tiktok.post`, `tiktok.posts`, `tiktok.profile`, `tiktok.transcript`, `youtube.comments`, `youtube.post`, `youtube.posts`, `youtube.profile`, `youtube.transcript` |
| `requests[].max_pages?` | `integer` or `null` | List endpoints only: walk up to this many pages with the cursor (default 1). Each page is a result and costs a page's price. |
| `requests[].params` | `object` | The endpoint's query params, as you would send them to it (strings, numbers or booleans). |
| `webhook_url?` | `string` or `null` | Also deliver this job's job.\* events to this URL: the URL of one of the account's webhook endpoints (its secret signs them). |

## Response

### 200 · 202

Run many requests (or one long one) as a job

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` |  |
| `data.cancel_requested_at` | `string` (date-time) or `null` |  |
| `data.created_at` | `string` (date-time) |  |
| `data.credits` | `object` |  |
| `data.credits.charged` | `integer` | Credits charged so far, each page once (items' prices; failed items are free). |
| `data.credits.max` | `integer` | max_credits: the most the job may spend. |
| `data.credits.reserved` | `integer` | Credits its running pages may still use (0 once the job ends). |
| `data.expires_at` | `string` (date-time) | The deadline: items not ended by then expire. |
| `data.finished_at` | `string` (date-time) or `null` | When the job ended; null while it runs. |
| `data.id` | `string` | The job ID (job_…). |
| `data.max_age` | `integer` or `null` | The job's max_age; null when it accepts no cached results. |
| `data.metadata` | `object` | Your metadata; {} when none. |
| `data.object` | `string` | Always job.<br>One of `job` |
| `data.request_counts` | `object` |  |
| `data.request_counts.canceled` | `integer` |  |
| `data.request_counts.expired` | `integer` |  |
| `data.request_counts.failed` | `integer` |  |
| `data.request_counts.queued` | `integer` | Not started. |
| `data.request_counts.running` | `integer` | Started (fetching, waiting for a retry or walking pages). |
| `data.request_counts.succeeded` | `integer` |  |
| `data.request_counts.total` | `integer` |  |
| `data.results_expire_at` | `string` (date-time) or `null` | When results are deleted; null while the job runs. |
| `data.results_url` | `string` or `null` | Every result as JSON Lines (one JobResult per line), signed: works without the API key until results_url_expires_at. Null until the job ends and after results_expire_at. |
| `data.results_url_expires_at` | `string` (date-time) or `null` |  |
| `data.started_at` | `string` (date-time) or `null` | When the first item started; null before. |
| `data.status` | `string` | queued: nothing started yet. running. canceling: canceled, running items finishing. completed: every item ended (check request_counts: there is no job-level failure). canceled. expired: the deadline passed; unfinished items expired.<br>One of `queued`, `running`, `canceling`, `completed`, `canceled`, `expired` |
| `data.webhook_url` | `string` or `null` | The job's own webhook URL; null when none. |
| `meta` | `object` | The shared route meta (see the API reference introduction). |
| `results?` | `object[]` | Only on 200 from create with wait: the first page of results. |
| `results[].completed_at` | `string` (date-time) |  |
| `results[].custom_id` | `string` |  |
| `results[].endpoint` | `string` | One of `facebook.search_ads`, `facebook.transcript`, `instagram.post`, `instagram.profile`, `instagram.transcript`, `tiktok.comments`, `tiktok.post`, `tiktok.posts`, `tiktok.profile`, `tiktok.transcript`, `youtube.comments`, `youtube.post`, `youtube.posts`, `youtube.profile`, `youtube.transcript` |
| `results[].error` | `object` or `null` | Exactly the synchronous error object; null on success and for the job's own cancel or deadline. |
| `results[].error.charged` | `boolean` | Whether the request was charged: always false, failed requests are free. |
| `results[].error.code` | `string` | Machine-readable error code (see the error codes list); stable. |
| `results[].error.details` | `object` | The code's dynamic values (the error codes list documents each code's keys); {} when none. |
| `results[].error.doc_url` | `string` | URL of this code's documentation. |
| `results[].error.message` | `string` | What went wrong and how to fix it, for humans and agents; wording may change. |
| `results[].error.param` | `string` or `null` | The query parameter or header the error is about; null when it is not about one input. |
| `results[].error.remediation` | `string` | What to do about this code, one sentence. |
| `results[].error.request_id` | `string` | Unique request ID; include it when contacting support. |
| `results[].error.retryable` | `boolean` | True when repeating the same request later may succeed (after details.retry_after when present). |
| `results[].error.status` | `integer` | The HTTP status of the response, repeated for clients that only see the body. |
| `results[].object` | `string` | Always job_result.<br>One of `job_result` |
| `results[].page_index` | `integer` | 0 for a single-item endpoint and a list's first page; n for the list's page n+1. |
| `results[].result` | `object` or `null` | Exactly the synchronous success envelope; null unless succeeded. |
| `results[].result.data` | `any` | The endpoint's data: its resource, or a list page's items. |
| `results[].result.meta` | `object` |  |
| `results[].result.page?` | `object` or `null` | List endpoints only. |
| `results[].status` | `string` | The page's outcome; an item's status is its last result's. canceled and expired results carry no result (error says why when it is not the job's cancel or deadline).<br>One of `succeeded`, `failed`, `canceled`, `expired` |
| `results[].status_code` | `integer` or `null` | The HTTP status the synchronous request answered; null when it did not run. |
| `results_page?` | `object` or `null` | Only with results: the page object of results (continue on the results route). |
| `results_page.end_reason` | `string` or `null` | Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.<br>One of `end`, `platform_limit`, `max_pages` |
| `results_page.has_more` | `boolean` | True when another page exists; then next_cursor is set. An empty page with has_more true is not the end. |
| `results_page.next_cursor` | `string` or `null` | Pass as cursor, with the same other parameters, to get the next page; null at the end. |
| `results_page.next_cursor_expires_at` | `string` (date-time) or `null` | When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors. |

### 400

400 Bad Request.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | The request parameters are missing or malformed, or the URL is not a supported link for this endpoint. | Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names. |

### 401

401 Unauthorized.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired). | Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url). |

### 402

402 Payment Required.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Buy credits (a human pays: details.purchase_url, or details.checkout makes a checkout link), then repeat the request; do not retry automatically. |
| `spend_limit_reached` | 402 | No | The API key reached its spend limit for the current period; the account may still have credits. | Wait until details.resets_at or raise the key's spend limit (PATCH /v1/api_keys/{id}); do not retry automatically. |

### 403

403 Forbidden.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code. | Do what details.reason says: if suspended, contact [support](https://staging.socialtap.dev/docs/index.md); otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP. |

### 409

409 Conflict.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `idempotency_key_in_progress` | 409 | Yes, later | A request with this Idempotency-Key is still running. | Retry after the number of seconds in the retry-after header to get that request's result. |

### 422

422 Unprocessable.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `idempotency_key_reused` | 422 | No | The Idempotency-Key was already used with a different request (another route, or another body). | Send a new Idempotency-Key for a different request; reuse a key only to retry the identical request. |

### 429

429 Too Many Requests.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead. | Wait for the number of seconds in the retry-after header, then retry; ask [support](https://staging.socialtap.dev/docs/index.md) to raise the ceiling if your sustained traffic needs more (calls without an API key: use one). |

## Test mode

A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.

operationId `jobs.create`

---

[HTML version](https://staging.socialtap.dev/docs/reference/jobs/create/) · [Docs index for AI agents](https://staging.socialtap.dev/llms.txt) · [All docs in one file](https://staging.socialtap.dev/llms-full.txt)