> For the complete documentation index, see [llms.txt](https://bountyv.gitbook.io/vdocs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bountyv.gitbook.io/vdocs/video-api/jobs.md).

# Job status

Poll the status of an asynchronous video job.

```
GET /api/v1/jobs/{id}
```

Returns the current status of a job created by [Reel Recreate](/vdocs/video-api/videos-generate.md) (`POST /api/v1/videos/generate`). You can only see jobs owned by your account. This is the shared job-status/polling page every async video pipeline links to; [Wan Reel](/vdocs/video-api/videos-wan-reel.md) uses its own poll route (`GET /api/v1/videos/wan-reel/{id}`) instead of this one.

## Authentication

`Authorization: Bearer sk_live_...`. See [Authentication](/vdocs/authentication.md).

## Request

No body. Just the `Authorization` header and the job id in the path.

| Field | Type          | Required | Description                                                |
| ----- | ------------- | -------- | ---------------------------------------------------------- |
| `id`  | string (path) | ✅        | The `job_id` returned when you submitted the video request |

## Response

```json
{
  "job_id": "nH7bK9xQ2m",
  "status": "processing",
  "progress": 42,
  "video_url": null,
  "error": null,
  "created_at": "2026-05-18T12:34:56.000Z",
  "completed_at": null
}
```

```json
{
  "job_id": "nH7bK9xQ2m",
  "status": "completed",
  "progress": 100,
  "video_url": "https://substance-api.com/api/v1/jobs/nH7bK9xQ2m/video",
  "error": null,
  "created_at": "2026-05-18T12:34:56.000Z",
  "completed_at": "2026-05-18T12:38:12.000Z"
}
```

| Field          | Type             | Description                                                            |
| -------------- | ---------------- | ---------------------------------------------------------------------- |
| `job_id`       | string           | The job identifier                                                     |
| `status`       | string           | One of `queued`, `processing`, `completed`, `failed`                   |
| `progress`     | integer          | 0–100 progress percentage                                              |
| `video_url`    | string \| null   | Points to `GET /api/v1/jobs/{id}/video` once `status` is `completed`   |
| `error`        | string \| null   | Present when `status` is `failed` (credits have already been refunded) |
| `created_at`   | ISO 8601         | When the job was submitted                                             |
| `completed_at` | ISO 8601 \| null | When the job finished                                                  |

### Status values

| Status       | Meaning                                              |
| ------------ | ---------------------------------------------------- |
| `queued`     | Accepted, waiting for a worker                       |
| `processing` | A worker is running the pipeline; inspect `progress` |
| `completed`  | Done — fetch `video_url`                             |
| `failed`     | Pipeline failed. Credits have already been refunded  |

## Downloading the video

```
GET /api/v1/jobs/{id}/video
```

Once `status` is `completed`, the `video_url` returned above points here. Streams the MP4 bytes back through our own domain (the upstream storage host is never revealed to the customer) — authenticate with the same Bearer key.

```bash
curl https://substance-api.com/api/v1/jobs/nH7bK9xQ2m/video \
  -H "Authorization: Bearer sk_live_..." \
  --output out.mp4
```

## Example

```bash
curl https://substance-api.com/api/v1/jobs/nH7bK9xQ2m \
  -H "Authorization: Bearer sk_live_..."
```

```js
async function waitForJob(jobId) {
  while (true) {
    const r = await fetch(`https://substance-api.com/api/v1/jobs/${jobId}`, {
      headers: { Authorization: `Bearer ${process.env.SUBSTANCE_API_KEY}` },
    });
    const job = await r.json();
    if (job.status === "completed") return job.video_url;
    if (job.status === "failed") throw new Error(job.error ?? "Failed");
    await new Promise((res) => setTimeout(res, 5000));
  }
}
```

## Polling guidance

* Standard videos: poll every 5 seconds
* Pro / high-fidelity: poll every 10 seconds
* Back off exponentially if you receive transient `5xx` errors
* A full video typically takes 1–6 minutes, so expect 15–60 polls per job

## Errors

| Status | When                                                                 |
| ------ | -------------------------------------------------------------------- |
| `401`  | Invalid or missing API key                                           |
| `404`  | Job doesn't exist or doesn't belong to your account                  |
| `409`  | Video stream requested (`/video`) before the job reached `completed` |
| `502`  | Stored video temporarily unavailable — safe to retry                 |

You can only retrieve jobs that were submitted with your own API key. See [Errors](/vdocs/errors.md) for full details.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bountyv.gitbook.io/vdocs/video-api/jobs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.