> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voyager.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoints and conventions

> Every Voyager API route at a glance, the base URL, and the conventions all of them share: IDs, times, lists, retries, errors and request IDs.

## Base URL

```text theme={"system"}
https://api.voyager.so/v1
```

Every request is HTTPS and JSON. Send your API key as a Bearer token:

```text theme={"system"}
Authorization: Bearer vy_live_...
```

Keep the key in the `VOYAGER_API_KEY` environment variable. See [Authentication](https://docs.voyager.so/api/authentication.md).

## Routes

| Area | Endpoints | What for |
| - | - | - |
| **Models** | `GET /models`, `GET /models/{id}` | Find a model and read the `input_schema` its `input` must match. See [Models](https://docs.voyager.so/api/models.md). |
| **Estimates** | `POST /estimate` | Check what a job would cost, and whether it can run, before you create it. |
| **Jobs** | `POST /jobs`, `GET /jobs/{id}`, `GET /jobs`, `POST /jobs/{id}/cancel` | Generate, wait, list and cancel. See [Jobs and polling](https://docs.voyager.so/api/jobs.md). |
| **Files** | `POST /files`, `POST /files/{id}/complete`, `GET /files/{id}`, `GET /files/{id}/content`, `DELETE /files/{id}` | Upload reference images, audio or video; download results. |
| **Cast** | `GET /cast`, `POST /cast`, `GET`, `PATCH`, `DELETE /cast/{id}`, references | Saved characters, locations and props for consistent shots. See [Cast](https://docs.voyager.so/api/cast.md). |
| **Voices** | `GET /voices` | Voices for speech jobs, including your workspace's voice clones. |
| **Account** | `GET /account` | Your workspace, plan, credits available and limits. |

Job types are `image`, `video`, `speech`, `music`, `sound_effect` and `3d`, plus `segment`, `upscale`, `audio_separation`, `remove_background` and `vectorize`. The type comes from the model you pick. The full contract is in the **API reference** tab, generated from the OpenAPI file.

## Conventions

* **IDs** are prefixed strings: `job_…`, `file_…`, `cst_…`, `evt_…`, `key_…`. Treat them as opaque.
* **Times** are ISO 8601 in UTC.
* **Lists** return `{"object": "list", "data": [...], "has_more": true, "next_cursor": "..."}`. Pass `?cursor=<next_cursor>` for the next page and `?limit=` (up to 100) for page size.
* **Retries** are safe on every `POST` when you send an `Idempotency-Key` header: a retry returns the original result instead of buying a second one. See [Idempotency](https://docs.voyager.so/api/jobs.md#idempotency).
* **Errors** share one envelope with a stable `code`. See [Errors](https://docs.voyager.so/api/errors.md).
* **Request IDs**: every response carries `X-Request-ID`. Include it when you contact support.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.