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

Current. Every new integration is built on v2.

API v1 reference

Deprecated. Kept for integrations that already use it.
v1 is deprecated. It gets no new features. An integration on v1 keeps working for now and should move to v2; support@syncwords.com helps with the move.
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 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.