StatusSupportGet API keyDashboard
JobsCancel a job

Jobs

Cancel a job

Use with AI

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

Authorizations

x-api-keystringheaderrequired

Your API key, with the jobs scope. Authentication

Path parameters

idstringrequired

Job ID (job_…).

Headers

idempotency-keystringmax 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

application/json

200

Cancel a job

dataobject
ShowHide 16 child fields
cancel_requested_atstring date-timenullable
created_atstring date-time
creditsobject
ShowHide 3 child fields
chargedinteger

Credits charged so far, each page once (items' prices; failed items are free).

maxinteger

max_credits: the most the job may spend.

reservedinteger

Credits its running pages may still use (0 once the job ends).

expires_atstring date-time

The deadline: items not ended by then expire.

finished_atstring date-timenullable

When the job ended; null while it runs.

idstring

The job ID (job_…).

max_ageintegernullable

The job's max_age; null when it accepts no cached results.

metadataobject

Your metadata; {} when none.

objectstring

Always job.

One ofjob

request_countsobject
ShowHide 7 child fields
canceledinteger
expiredinteger
failedinteger
queuedinteger

Not started.

runninginteger

Started (fetching, waiting for a retry or walking pages).

succeededinteger
totalinteger
results_expire_atstring date-timenullable

When results are deleted; null while the job runs.

results_urlstringnullable

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.

results_url_expires_atstring date-timenullable
started_atstring date-timenullable

When the first item started; null before.

statusstring

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.

One ofqueuedrunningcancelingcompletedcanceledexpired

webhook_urlstringnullable

The job's own webhook URL; null when none.

metaobject

The shared route meta (see the API reference introduction).

400

400 Bad Request.

invalid_inputNo retry

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.

unauthorizedNo retry

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.

forbiddenNo retry

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

job_not_foundNo retry

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.

idempotency_key_in_progressYes, 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.

idempotency_key_reusedNo retry

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.

rate_limitedYes, 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 to raise the ceiling; without an API key, send one.

operationId jobs.cancel