# SyncWords API documentation > The SyncWords APIs: live captioning, translation and dubbing with the Live API, and recorded media with the VOD Express API. Every page is also Markdown: add `.md` to its URL. The VOD Express API's OpenAPI document is https://docs.syncwords.com/vod-express/openapi.json. ## Overview - [SyncWords API documentation](https://docs.syncwords.com/index.md): The SyncWords APIs, for live streams and for recorded media. ## Live API: Get started - [Live API](https://docs.syncwords.com/live/index.md): Create, run and manage live captioning, translation and dubbing services over HTTP. - [API reference](https://docs.syncwords.com/live/api-reference.md): The interactive reference of the Live API, and which version to build on. ## VOD Express API: Guides: Get started - [VOD Express API](https://docs.syncwords.com/vod-express/index.md): Dub, translate and caption recorded video and audio, file by file. - [Quickstart](https://docs.syncwords.com/vod-express/quickstart.md): Dub an English video into Spanish, from token to downloaded MP4, with curl, Python or Node.js. - [Authentication](https://docs.syncwords.com/vod-express/authentication.md): SyncWords API keys, bearer tokens, and what a 401 or 403 means. - [Environments](https://docs.syncwords.com/vod-express/environments.md): Base URLs, where tokens come from, and what to check before going live. ## VOD Express API: Guides: Concepts - [How it works](https://docs.syncwords.com/vod-express/concepts/how-it-works.md): Projects, where the media comes from, the processing service and where the results go. - [Projects](https://docs.syncwords.com/vod-express/concepts/projects.md): Create, change, start, stop and delete projects. - [Files](https://docs.syncwords.com/vod-express/concepts/files.md): Input files, their processing states, outputs, retries and downloads. - [Inputs](https://docs.syncwords.com/vod-express/concepts/inputs.md): Where a project's media comes from — its input folder, an RSS feed or a Media RSS feed — and the feeds a feed project publishes. - [Glossary](https://docs.syncwords.com/vod-express/concepts/glossary.md): The words these docs use, in one place. ## VOD Express API: Guides: Configure a project - [The project config](https://docs.syncwords.com/vod-express/configuration/overview.md): The four blocks of a config, where to find every option, and how it is validated. - [Transcription](https://docs.syncwords.com/vod-express/configuration/transcription.md): The source language and the speech recognition engine. - [Translation](https://docs.syncwords.com/vod-express/configuration/translation.md): Target languages, translation engines, glossaries and style prompts. - [Dubbing](https://docs.syncwords.com/vod-express/configuration/dubbing.md): Voices, voice cloning, and a clean dub or a voice-over. - [Choosing a voice](https://docs.syncwords.com/vod-express/configuration/voices.md): A safe first voice for each provider, how to find others, and how to check one before a whole season. - [Outputs](https://docs.syncwords.com/vod-express/configuration/outputs.md): Where the results go — the output folder, output feeds — and the videos, audio files and subtitle files written there. - [Languages](https://docs.syncwords.com/vod-express/configuration/languages.md): Every language code, and the engines that transcribe and translate it. - [Config reference](https://docs.syncwords.com/vod-express/configuration/reference.md): Every field of a project's config on build 0.9.0-alpha1-2026-10-20T14-10Z-3f05aa, generated from its schema. ## VOD Express API: Guides: Upload media - [Uploading media](https://docs.syncwords.com/vod-express/uploads/overview.md): Three ways into a project's input folder, and which to choose. - [Upload with the AWS CLI](https://docs.syncwords.com/vod-express/uploads/aws-role.md): Get an IAM role for your account, then use aws s3 cp and sync for inputs and outputs. - [Upload through the API](https://docs.syncwords.com/vod-express/uploads/api-uploads.md): S3 uploads signed by the API, in one PUT or in parts, from scripts, servers and browsers. - [Your own bucket](https://docs.syncwords.com/vod-express/uploads/own-bucket.md): Keep a project's input and output folders in your own S3 or S3-compatible bucket, with keys you enter once per account. ## VOD Express API: Guides: Examples - [Dub a video](https://docs.syncwords.com/vod-express/examples/dub-a-video.md): English to Spanish, with cloned voices, a chosen voice, or a voice-over. - [Several languages](https://docs.syncwords.com/vod-express/examples/multi-language.md): One video with several dubbed tracks, per-language files, and mixed engines. - [Audio only](https://docs.syncwords.com/vod-express/examples/audio-only.md): Podcasts and audiobooks in, MP3 and M4A out. - [Subtitles and captions](https://docs.syncwords.com/vod-express/examples/subtitles.md): SRT and WebVTT files, and subtitle streams inside the video. - [A whole season](https://docs.syncwords.com/vod-express/examples/season-batch.md): Upload a folder tree, follow hundreds of files, collect every output. - [Automate the whole flow](https://docs.syncwords.com/vod-express/examples/automation.md): A complete client in Node.js or Python — token, project, upload, wait, download. ## VOD Express API: Guides: Going to production - [Monitoring and polling](https://docs.syncwords.com/vod-express/guides/monitoring.md): Knowing when files are done, and what to do when they are not. - [Webhooks](https://docs.syncwords.com/vod-express/guides/webhooks.md): Be called when a file is done or failed and when a project stops, instead of polling. - [Errors](https://docs.syncwords.com/vod-express/guides/errors.md): The error body, every error code, and the validation messages you are likely to meet. - [Limits and behaviour](https://docs.syncwords.com/vod-express/guides/limits.md): The numbers and rules worth knowing before you go to production. - [Generate a client](https://docs.syncwords.com/vod-express/guides/clients.md): Typed clients from the OpenAPI document, and a Postman collection. ## VOD Express API: Guides: Help - [Changelog](https://docs.syncwords.com/vod-express/changelog.md): What changed in the API and in the processing builds, and the known issues of each build. - [Support](https://docs.syncwords.com/vod-express/support.md): How to reach SyncWords, and what to send so we can help at once. ## VOD Express API: API reference: Overview - [API reference](https://docs.syncwords.com/vod-express/api-reference/introduction.md): Base URL, authentication and conventions of every endpoint. ## VOD Express API: API reference: Account - [Create a token](https://docs.syncwords.com/vod-express/api-reference/post-token-create.md) - [Who am I](https://docs.syncwords.com/vod-express/api-reference/get-whoami.md) - [Get the upload role](https://docs.syncwords.com/vod-express/api-reference/get-account-aws-access.md) - [Create the upload role](https://docs.syncwords.com/vod-express/api-reference/put-account-aws-access.md) - [Revoke the upload role](https://docs.syncwords.com/vod-express/api-reference/delete-account-aws-access.md) - [List storage connections](https://docs.syncwords.com/vod-express/api-reference/get-account-storage-connections.md) - [Add a storage connection](https://docs.syncwords.com/vod-express/api-reference/post-account-storage-connections.md) - [Get a storage connection](https://docs.syncwords.com/vod-express/api-reference/get-account-storage-connections-id.md) - [Change a storage connection](https://docs.syncwords.com/vod-express/api-reference/patch-account-storage-connections-id.md) - [Delete a storage connection](https://docs.syncwords.com/vod-express/api-reference/delete-account-storage-connections-id.md) - [Check a storage connection](https://docs.syncwords.com/vod-express/api-reference/post-account-storage-connections-id-check.md) - [Get the account settings](https://docs.syncwords.com/vod-express/api-reference/get-account-settings.md) - [Change the account settings](https://docs.syncwords.com/vod-express/api-reference/patch-account-settings.md) ## VOD Express API: API reference: Schema - [List builds](https://docs.syncwords.com/vod-express/api-reference/get-build-versions.md) - [Get the config schema](https://docs.syncwords.com/vod-express/api-reference/get-schema.md) - [List languages](https://docs.syncwords.com/vod-express/api-reference/get-enums-languages.md) - [List known voices](https://docs.syncwords.com/vod-express/api-reference/get-voices.md) - [List engines and output types](https://docs.syncwords.com/vod-express/api-reference/get-enums-name.md) ## VOD Express API: API reference: Projects - [List projects](https://docs.syncwords.com/vod-express/api-reference/get-projects.md) - [Create a project](https://docs.syncwords.com/vod-express/api-reference/post-projects.md) - [Get a project](https://docs.syncwords.com/vod-express/api-reference/get-projects-id.md) - [Update a project](https://docs.syncwords.com/vod-express/api-reference/patch-projects-id.md) - [Update a project (PUT)](https://docs.syncwords.com/vod-express/api-reference/put-projects-id.md) - [Delete a project](https://docs.syncwords.com/vod-express/api-reference/delete-projects-id.md) - [Start a project](https://docs.syncwords.com/vod-express/api-reference/post-projects-id-start.md) - [Stop a project](https://docs.syncwords.com/vod-express/api-reference/post-projects-id-stop.md) - [Get the service status](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-status.md) - [Get the config](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-config.md) ## VOD Express API: API reference: Files - [List input files](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-files.md) - [Get an input file](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-files-name.md) - [Download an input](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-files-name-download.md) - [Get file metadata](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-files-name-meta.md) - [Retry a file](https://docs.syncwords.com/vod-express/api-reference/post-projects-id-files-name-retry.md) - [Delete an input](https://docs.syncwords.com/vod-express/api-reference/delete-projects-id-files-name.md) - [List outputs](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-outputs.md) - [Download an output](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-outputs-download.md) ## VOD Express API: API reference: Feeds - [Check the source feed](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-source-feed.md) - [Check a feed before saving it](https://docs.syncwords.com/vod-express/api-reference/post-source-feeds-check.md) - [Get an output feed](https://docs.syncwords.com/vod-express/api-reference/get-feeds-project-id-language-feed-xml.md) - [Get a feed’s media file](https://docs.syncwords.com/vod-express/api-reference/get-feeds-project-id-language-media-name.md) ## VOD Express API: API reference: Uploads - [Start an upload](https://docs.syncwords.com/vod-express/api-reference/post-projects-id-uploads.md) - [Sign a part](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-uploads-upload-id-parts-part-number.md) - [List uploaded parts](https://docs.syncwords.com/vod-express/api-reference/get-projects-id-uploads-upload-id-parts.md) - [Complete an upload](https://docs.syncwords.com/vod-express/api-reference/post-projects-id-uploads-upload-id-complete.md) - [Abort an upload](https://docs.syncwords.com/vod-express/api-reference/delete-projects-id-uploads-upload-id.md) ## VOD Express API: API reference: Webhooks - [List webhooks](https://docs.syncwords.com/vod-express/api-reference/get-webhooks.md) - [Create a webhook](https://docs.syncwords.com/vod-express/api-reference/post-webhooks.md) - [Get a webhook](https://docs.syncwords.com/vod-express/api-reference/get-webhooks-id.md) - [Change a webhook](https://docs.syncwords.com/vod-express/api-reference/patch-webhooks-id.md) - [Delete a webhook](https://docs.syncwords.com/vod-express/api-reference/delete-webhooks-id.md) - [Rotate the secret](https://docs.syncwords.com/vod-express/api-reference/post-webhooks-id-rotate-secret.md) - [List deliveries](https://docs.syncwords.com/vod-express/api-reference/get-webhooks-id-deliveries.md) - [Send a delivery again](https://docs.syncwords.com/vod-express/api-reference/post-webhooks-id-deliveries-event-id-retry.md) - [Send a test event](https://docs.syncwords.com/vod-express/api-reference/post-webhooks-id-test.md)