> 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/video-overview.md).

# Overview

Long-running video generation. Most video pipelines are asynchronous: submit a job, receive an id, poll until the render is ready.

```
Video API — multiple endpoints, see below
```

> Access to every endpoint on this page is gated by your account's `video` entitlement. Calls return `403 product_disabled` if it isn't enabled — contact your account manager.

## How it works

Each render takes anywhere from 30 seconds to several minutes, so the flow is always submit-then-poll (except Omni Flash, which blocks and returns the finished video directly — see below):

```
1. POST /api/v1/videos/<pipeline>   →  { job_id | generation_id, status: "queued" | "pending" }
2. GET  /api/v1/jobs/<id>           →  { status, progress, video_url? }   (or the pipeline's own poll route)
3. Repeat step 2 every ~5-10s until status is "completed" or "failed".
```

## Endpoints

| Endpoint                                                                                   | Method + Path                              | Description                                                                                                                                 |
| ------------------------------------------------------------------------------------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| [Reel Recreate](/vdocs/video-api/videos-generate.md)                                       | `POST /api/v1/videos/generate`             | Identity-aware video pipeline — recreate a reference reel with a new face. Submit a job, poll [Job status](/vdocs/video-api/jobs.md).       |
| [Wan Reel](/vdocs/video-api/videos-wan-reel.md)                                            | `POST /api/v1/videos/wan-reel`             | Swap a face into a driving reel on self-hosted Wan 2.2 Animate — the reel's real motion, scene, and audio are kept. Has its own poll route. |
| [Seedance 2 Dirty Dan Edition](/vdocs/frontier-passthrough/frontier-seedance-dirty-dan.md) | `POST /api/v1/frontier/seedance-dirty-dan` | Animate one still into an **uncensored** clip. Requires the `nsfw` product. Async.                                                          |
| [Job status](/vdocs/video-api/jobs.md)                                                     | `GET /api/v1/jobs/{id}`                    | Poll progress and fetch the final MP4 once a `videos/generate` job completes.                                                               |

## Quick start

```bash
# 1. Submit (Reel Recreate)
curl https://substance-api.com/api/v1/videos/generate \
  -H "Authorization: Bearer sk_live_..." \
  -F "face=@face.jpg" \
  -F "reference_video_url=https://www.tiktok.com/@user/video/12345"

# 2. Poll
curl https://substance-api.com/api/v1/jobs/job_abc123 \
  -H "Authorization: Bearer sk_live_..."
```

## Pricing & refunds

Credits are reserved at submission and charged on a successful render. Failed jobs are refunded in full. See [Credits & pricing](/vdocs/account/credits.md) for current rates.


---

# 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/video-overview.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.