> 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/api-reference/api.md).

# Overview

All endpoints are under:

```
https://substance-api.com/api/v1/
```

Every request authenticates with a Bearer key (a few tools take the key in the body instead — noted on their page):

```
Authorization: Bearer sk_live_...
```

See [Authentication](/vdocs/authentication.md) for details, [Errors](/vdocs/errors.md) for status codes, and [Credits & pricing](/vdocs/account/credits.md) for current per-call rates.

## Account

| Endpoint                                              | Method | Description                                          |
| ----------------------------------------------------- | ------ | ---------------------------------------------------- |
| [`/credits`](/vdocs/account/credits.md)               | `GET`  | View balance and per-call pricing                    |
| [`/topup`](/vdocs/account/topup.md)                   | `POST` | Create a crypto invoice to add credits               |
| [`/generations`](/vdocs/account/generations.md)       | `GET`  | List, fetch, and download past generations           |
| [`/me`](/vdocs/account/me.md)                         | `GET`  | Account info, entitlements, and balance              |
| [`/uploads/sign`](/vdocs/account/uploads-sign.md)     | `POST` | Get a presigned URL to upload large files            |
| [`/auth/device-login`](/vdocs/account/device-auth.md) | `POST` | Log in the desktop app (username/password → API key) |

## Image API

| Endpoint                                                    | Method | Description                                     |
| ----------------------------------------------------------- | ------ | ----------------------------------------------- |
| [Overview](/vdocs/image-api/images-overview.md)             | —      | Image API at a glance                           |
| [`/images/txt2img`](/vdocs/image-api/images-txt2img.md)     | `POST` | Generate an image from a text prompt            |
| [`/images/edit`](/vdocs/image-api/images-edit.md)           | `POST` | Edit an uploaded image from an instruction      |
| [`/images/i2i`](/vdocs/image-api/images-i2i.md)             | `POST` | Image-to-image / inpaint at a chosen strength   |
| [`/images/img2video`](/vdocs/image-api/images-img2video.md) | `POST` | Animate a still image into a short clip (async) |

## Frontier Passthrough

Raw access to the frontier models on each provider's own parameters, for callers who don't want the normalised Image API shape.

| Endpoint                                                                                                   | Method | Description                                                       |
| ---------------------------------------------------------------------------------------------------------- | ------ | ----------------------------------------------------------------- |
| [Overview](/vdocs/frontier-passthrough/frontier-overview.md)                                               | —      | What passthrough covers, reference formats, pricing               |
| [`/frontier/nano-banana-pro`](/vdocs/frontier-passthrough/frontier-nano-banana-pro.md)                     | `POST` | Google gemini-3-pro-image-preview, native params                  |
| [`/frontier/chatgpt-image`](/vdocs/frontier-passthrough/frontier-chatgpt-image.md)                         | `POST` | OpenAI gpt-image-2, native params                                 |
| [`/frontier/seedream`](/vdocs/frontier-passthrough/frontier-seedream.md)                                   | `POST` | Seedream 4.x incl. sequential sets                                |
| [`/frontier/seedream-5-pro`](/vdocs/frontier-passthrough/frontier-seedream-5-pro.md)                       | `POST` | Seedream 5 Pro incl. sequential sets                              |
| [`/frontier/seedream-5-pro-uncensored`](/vdocs/frontier-passthrough/frontier-seedream-5-pro-uncensored.md) | `POST` | Seedream 5 Pro on the pre-filter-off endpoint (`nsfw` product)    |
| [`/frontier/seedance`](/vdocs/frontier-passthrough/frontier-seedance.md)                                   | `POST` | Seedance 2.0 with image + video + audio refs (async)              |
| [`/frontier/seedance-dirty-dan`](/vdocs/frontier-passthrough/frontier-seedance-dirty-dan.md)               | `POST` | Seedance 2 image-to-video, **uncensored** (`nsfw` product, async) |
| [`/frontier/omni-flash`](/vdocs/frontier-passthrough/frontier-omni-flash.md)                               | `POST` | Gemini Omni Flash text-to-video (synchronous)                     |

## YouTube Tools API

| Endpoint                                                                | Method | Description                                  |
| ----------------------------------------------------------------------- | ------ | -------------------------------------------- |
| [Overview](/vdocs/youtube-tools-api/youtube-overview.md)                | —      | YouTube tools at a glance                    |
| [`/thumbnail/generate`](/vdocs/youtube-tools-api/thumbnail-generate.md) | `POST` | Generate a thumbnail from a brief + refs     |
| [`/thumbnail/prompt`](/vdocs/youtube-tools-api/thumbnail-prompt.md)     | `POST` | Prompt assistant (free)                      |
| [`/youtube/lyric-video`](/vdocs/youtube-tools-api/lyric-video.md)       | `POST` | Render a lyric video from a song (async)     |
| [`/youtube/music-short`](/vdocs/youtube-tools-api/music-short.md)       | `POST` | Render a music short (async)                 |
| [`/music/lyria`](/vdocs/youtube-tools-api/music-lyria.md)               | `POST` | Generate a track from a prompt (synchronous) |
| [`/music/suno`](/vdocs/youtube-tools-api/music-suno.md)                 | `POST` | Generate a full song, two takes (async)      |

## Game Tools API

| Endpoint                                                   | Method | Description                            |
| ---------------------------------------------------------- | ------ | -------------------------------------- |
| [`/steam/artwork`](/vdocs/game-tools-api/steam-artwork.md) | `POST` | Generate Steam store / capsule artwork |

## Video API

| Endpoint                                                  | Method | Description                                           |
| --------------------------------------------------------- | ------ | ----------------------------------------------------- |
| [Overview](/vdocs/video-api/video-overview.md)            | —      | Video API at a glance                                 |
| [`/videos/generate`](/vdocs/video-api/videos-generate.md) | `POST` | Recreate a reference reel with a new identity (async) |
| [`/videos/wan-reel`](/vdocs/video-api/videos-wan-reel.md) | `POST` | Swap a face onto a reel (async)                       |
| [`/jobs/{id}`](/vdocs/video-api/jobs.md)                  | `GET`  | Poll the status of any async job                      |

## Soul API

| Endpoint                                                              | Method         | Description                              |
| --------------------------------------------------------------------- | -------------- | ---------------------------------------- |
| [Overview](/vdocs/soul-api/soul-overview.md)                          | —              | Soul (reusable identity) API at a glance |
| [`/identities/create`](/vdocs/soul-api/identities-create.md)          | `POST` / `GET` | Create a Soul, or list your Souls        |
| [`/identities/{id}/generate`](/vdocs/soul-api/identities-generate.md) | `POST`         | Generate an image locked to a saved Soul |

## Clip API

| Endpoint                                         | Method | Description                                       |
| ------------------------------------------------ | ------ | ------------------------------------------------- |
| [Overview](/vdocs/clip-api/clip-overview.md)     | —      | Clip tools at a glance                            |
| [`/clip/clean`](/vdocs/clip-api/clip-clean.md)   | `POST` | Re-download a reel without the platform watermark |
| [`/clip/split`](/vdocs/clip-api/clip-split.md)   | `POST` | Split a reel into start + end sections            |
| [`/clip/stitch`](/vdocs/clip-api/clip-stitch.md) | `POST` | Stitch a hook + a Vault ending into one reel      |

## Stream Tools API

| Endpoint                                               | Method | Description                   |
| ------------------------------------------------------ | ------ | ----------------------------- |
| [`/stream/kit`](/vdocs/stream-tools-api/stream-kit.md) | `POST` | Generate a stream overlay kit |


---

# 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/api-reference/api.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.