Cancel a job · SocialTap API reference

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.

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

curl -X POST 'https://staging.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

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

idstringrequired

Job ID (job_…).

Headers

Name	Type	Description	Example
`idempotency-key` optional	`string` 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.	—

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

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

dataobject

Show 16 child fields

cancel_requested_atstring date-timenullable

created_atstring date-time

creditsobject

Show 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

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

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.

invalid_inputNo retry

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

unauthorizedNo retry

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

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

forbiddenNo retry

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

404

404 Not Found.

Code	HTTP	Retry	Meaning	What to do
`job_not_found`	404	No	No job with this ID exists for the account: unknown, or past its retention.	Check the job ID; finished jobs are kept for a limited time.

job_not_foundNo retry

No job with this ID exists for the account: unknown, or 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 number of seconds in the retry-after header to get that request's result.

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

idempotency_key_reusedNo retry

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 to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

rate_limitedYes, 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 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.cancel