# Cancel a job

Jobs

POST `/v1/jobs/{id}/cancel`

Stops the job: items not started become `canceled` (free); items already running finish and are charged. The job is `canceling` until they do, then `canceled`. Canceling an ended job changes nothing. Free.

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

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://socialtap.dev/v1/jobs/<id>/cancel' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

## Authorizations

`x-api-key`stringheaderrequired

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

## Path parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `id` required | `string` | Job ID (job_…). | — |

## 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. | — |

## Response

### 200

Cancel 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). |

### 400

400 Bad Request.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |

### 401

401 Unauthorized.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |

### 403

403 Forbidden.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too 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, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |

### 404

404 Not Found.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `job_not_found` | 404 | No | The account has no job with this ID: the ID is wrong, or the job is past its retention. | Check the job ID. Finished jobs are kept for a limited time. |

### 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 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 | This Idempotency-Key was already used for a different request (another route or body). Or it was used for this same request, which ran and returned a secret we no longer keep (details.reason answer_expired): running it again would create another. | Use a new Idempotency-Key for a different request, and reuse a key only to retry the identical request. With reason answer_expired, check what the first request created (GET /v1/api_keys, GET /v1/webhook_endpoints) before sending it again under a new key. |

### 429

429 Too Many Requests.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

operationId `jobs.cancel`

---

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