# API reference

> The interactive reference of the Live API, and which version to build on.

The Live API's reference is served by the API itself: Swagger UI, generated from the API's own
OpenAPI document, so it describes exactly the version that is running. It will move into these
pages, endpoint by endpoint; until then, the links below are the reference.

- **[API v2 reference](https://api-live2.syncwords.com/v2/documentation)**: **Current.** Every new integration is built on v2.
- **[API v1 reference](https://api-live2.syncwords.com/v1/documentation)**: **Deprecated.** Kept for integrations that already use it.

> **Warning:**
> **v1 is deprecated.** It gets no new features. An integration on v1 keeps working for now and
> should move to v2; [support@syncwords.com](mailto:support@syncwords.com) helps with the move.

> **Note:**
> The **Build Migrations** group of the v2 page (`/admin/…`) is for SyncWords administrators only;
> everything else is yours to call.

## Using the reference

Swagger UI sends requests from the browser once it has a token: call `POST /token/create` first
(under **Auth**, at the top of the v2 page), then paste the `access_token` into **Authorize**.
[Authentication](/vod-express/authentication) explains the keys and the token.

## The OpenAPI document

The document behind the v2 page is YAML, at
`https://api-live2.syncwords.com/api/v2/docs?api-docs.yaml`. It generates a typed client
the same way the VOD Express document does; see [Generate a client](/vod-express/guides/clients).