# Get a job (free to poll)

Jobs

GET `/v1/jobs/{id}`

The job's status, per-state request counts and credits. Free: poll it, or long-poll with `wait`.

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

## Example

cURL:

```shell
curl 'https://staging.socialtap.dev/v1/jobs/<id>' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

## Authorizations

`x-api-key`stringheaderrequired

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

## Path parameters

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

## 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 (a long poll): the answer is the job as it is then. | — |

## Response

### 200

Get a job (free to poll)

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

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

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

### 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.get`

---

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