# developers.synthesia.io

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.synthesia.io/docs/_mcp/server

## Docs

- [Introduction](https://developers.synthesia.io/docs/introduction.md): Access Synthesia’s API documentation to integrate AI video generation into your applications. Learn how to automate personalized video creation, explore API features, and manage rate limits effectively.
- [Interactive Avatars](https://developers.synthesia.io/docs/interactive-avatars.md)
- [Interactive Avatar: Concepts](https://developers.synthesia.io/docs/ia-concepts.md): This page builds the mental model for the Interactive Avatar API and defines the vocabulary the rest of the docs use.
- [Interactive Avatar: Integration Overview](https://developers.synthesia.io/docs/ia-overview.md)
- [Interactive Avatar: LiveKit Plugin reference](https://developers.synthesia.io/docs/ia-livekit-plugin-reference.md): Complete reference for the Synthesia plugin for LiveKit Agents, available for Python (livekit-plugins-synthesia) and Node.js (@livekit/agents-plugin-synthesia).
- [Interactive Avatar: Quickstarts](https://developers.synthesia.io/docs/interactive-avatar-quickstarts.md): Runnable recipes for Synthesia Interactive Avatars: photoreal, lip-synced avatars you can talk to in your browser.
- [Interactive Avatar: Minimal Quickstart](https://developers.synthesia.io/docs/interactive-avatar-minimal-quickstart.md)
- [Interactive Avatar: RAG Quickstart](https://developers.synthesia.io/docs/interactive-avatar-rag-quickstart.md)
- [Interactive Avatar: Tools Quickstart](https://developers.synthesia.io/docs/interactive-avatar-tools-quickstart.md)
- [Interactive Avatars: Operational trust](https://developers.synthesia.io/docs/ia-operational-trust.md): What to know before you run Interactive Avatar in production: pricing, limits, and limitations.
- [Synthesia MCP](https://developers.synthesia.io/docs/synthesia-mcp.md): Connect Synthesia to the AI tools your team already works in.
- [Video API Introduction](https://developers.synthesia.io/docs/video-api-introduction.md): Reference documentation about Synthesia's Video API.
- [Video API Quickstart](https://developers.synthesia.io/docs/synthesia-api-quickstart.md): Begin your journey with Synthesia’s API by generating your first AI video. This quickstart guide provides step-by-step instructions on creating API keys, crafting synthetic videos, and downloading them efficiently.
- [Templates](https://developers.synthesia.io/docs/templates.md)
- [Videos](https://developers.synthesia.io/docs/videos.md): Explore Synthesia’s API Videos Reference to learn how to create, retrieve, update, and delete AI-generated videos programmatically. Access detailed documentation on video object properties, status management, and integration tips for seamless video automation.
- [Webhooks](https://developers.synthesia.io/docs/webhooks.md)
- [Audit Logs](https://developers.synthesia.io/docs/audit-logs.md): Audit logs provide a chronological record of user and administrator actions in Synthesia, helping organizations monitor usage, detect anomalies, and demonstrate compliance.
- [Assets](https://developers.synthesia.io/docs/assets-1.md): The **Assets API** manages files uploaded to Synthesia, such as video, image, or audio assets.   Assets are typically used as input for other API endpoints, like the **Dubbing API** or **Video API**.
- [Guide: Create a video from a template](https://developers.synthesia.io/docs/guide-create-a-video-from-template.md): Learn how to automate personalized AI video creation using Synthesia’s API templates. This comprehensive guide provides step-by-step instructions on setting up video templates, adding dynamic variables, and generating customized videos programmatically.
- [Guide: Zapier integration](https://developers.synthesia.io/docs/guide-synthesia-zapier.md): Discover how to seamlessly integrate Synthesia with Zapier to automate AI video creation without coding. This guide provides step-by-step instructions to connect your Synthesia API key, set up triggers, and streamline personalized video workflows.
- [Guide: Dub your videos via Synthesia API](https://developers.synthesia.io/docs/upload-large-files-via-temporary-aws-credentials.md): This guide shows how to dub one or many videos through the Synthesia API using a single, resumable Python script. It explains the end-to-end logic, key concepts, the API endpoints involved, and provides a ready-to-run CLI with examples and troubleshooting.
- [List of supported voices](https://developers.synthesia.io/docs/voices.md): Explore the comprehensive list of voices available in Synthesia’s API, including language, gender, and unique voice IDs. Utilize this reference to select the perfect voice for your AI-generated videos.
- [Webhook events](https://developers.synthesia.io/docs/webhook-events.md): Explore Synthesia’s API webhook events to receive real-time notifications for video processing statuses. Learn how to implement event-driven workflows with video.completed and video.failed events.
- [Verifying Synthesia Signatures](https://developers.synthesia.io/docs/verifying-synthesia-signatures.md): Ensure the authenticity of events received from Synthesia by verifying signatures included in webhook requests. This guide provides step-by-step instructions to construct and validate signatures using your unique webhook secret, enhancing the security of your integrations.
- [Script supported XML tags](https://developers.synthesia.io/docs/script-supported-xml-tags.md): List of supported XML tags for Synthesia scripts.
- [Billing](https://developers.synthesia.io/docs/billing.md): The Billing API lets you retrieve your workspace's current billing period and credit balance.
- [List of stock avatars](https://developers.synthesia.io/docs/avatars.md): Explore Synthesia’s API documentation for a comprehensive list of stock avatars, complete with associated IDs. Learn how to retrieve specific avatar IDs to enhance your AI video projects.
- [Errors](https://developers.synthesia.io/docs/errors.md)
- [Scopes](https://developers.synthesia.io/docs/scopes.md)
- [API updates](https://developers.synthesia.io/docs/changelog/llms.txt)

## API Docs

- Synthesia API reference > billing [Get the credit balance](https://developers.synthesia.io/docs/api-reference/billing/get-billing-credits.md)
- Synthesia API reference > interactive-avatars [Start an interactive avatar session](https://developers.synthesia.io/docs/api-reference/interactive-avatars/create-interactive-avatar-session.md)
- Synthesia API reference > interactive-avatars [Create an interactive avatar](https://developers.synthesia.io/docs/api-reference/interactive-avatars/create-interactive-avatar.md)
- Video API reference (v2) > Templates [List templates](https://developers.synthesia.io/docs/video-api-reference/templates/list-templates.md)
- Video API reference (v2) > Templates [Retrieve a template](https://developers.synthesia.io/docs/video-api-reference/templates/retrieve-a-template.md)
- Video API reference (v2) > Translations [Get supported languages for translations](https://developers.synthesia.io/docs/video-api-reference/translations/get-supported-languages-for-translations.md)
- Video API reference (v2) > Translations [Get video translations of a given root video id](https://developers.synthesia.io/docs/video-api-reference/translations/get-video-translations-of-a-given-root-video-id.md)
- Video API reference (v2) > Translations [Start/Update a video translation](https://developers.synthesia.io/docs/video-api-reference/translations/start-update-a-video-translation.md)
- Video API reference (v2) > Translations [Translate and generate a video from XLIFF definition](https://developers.synthesia.io/docs/video-api-reference/translations/translate-and-generate-a-video-from-xliff-definition.md)
- Video API reference (v2) > Videos [Create a video from a template](https://developers.synthesia.io/docs/video-api-reference/videos/create-a-video-from-a-template.md)
- Video API reference (v2) > Videos [List videos](https://developers.synthesia.io/docs/video-api-reference/videos/list-videos.md)
- Video API reference (v2) > Videos [Create a video](https://developers.synthesia.io/docs/video-api-reference/videos/create-a-video.md)
- Video API reference (v2) > Videos [Retrieve a video](https://developers.synthesia.io/docs/video-api-reference/videos/retrieve-a-video.md)
- Video API reference (v2) > Videos [Delete a video](https://developers.synthesia.io/docs/video-api-reference/videos/delete-a-video.md)
- Video API reference (v2) > Videos [Update a video](https://developers.synthesia.io/docs/video-api-reference/videos/update-a-video.md)
- Video API reference (v2) > Videos [Retrieve XLIFF content for a video](https://developers.synthesia.io/docs/video-api-reference/videos/retrieve-xliff-content-for-a-video.md)
- Video API reference (v2) > Videos [Retrieve a thumbnail](https://developers.synthesia.io/docs/video-api-reference/videos/retrieve-a-thumbnail.md)
- Video API reference (v2) > Videos [Retrieve a GIF thumbnail](https://developers.synthesia.io/docs/video-api-reference/videos/retrieve-a-gif-thumbnail.md)
- Video API reference (v2) > Videos [Retrieve a GIF/JPG thumbnail](https://developers.synthesia.io/docs/video-api-reference/videos/retrieve-a-gif-jpg-thumbnail.md)
- Video API reference (v2) > Webhooks [Retrieve a webhook](https://developers.synthesia.io/docs/video-api-reference/webhooks/retrieve-a-webhook.md)
- Video API reference (v2) > Webhooks [Delete a webhook](https://developers.synthesia.io/docs/video-api-reference/webhooks/delete-a-webhook.md)
- Video API reference (v2) > Webhooks [List webhooks](https://developers.synthesia.io/docs/video-api-reference/webhooks/list-webhooks.md)
- Video API reference (v2) > Webhooks [Create a Webhook](https://developers.synthesia.io/docs/video-api-reference/webhooks/create-a-webhook.md)
- Video API reference (v2) > Audit Logs [Query audit log events](https://developers.synthesia.io/docs/video-api-reference/audit-logs/get-audit-log-events.md)
- Video API reference (v2) > Audit Logs [Search audit log events (Advanced)](https://developers.synthesia.io/docs/video-api-reference/audit-logs/search-audit-log-events.md)
- Video API reference (v2) > Audit Logs [Export audit log events as CSV](https://developers.synthesia.io/docs/video-api-reference/audit-logs/export-audit-log-events.md)
- Video API reference (v2) > Dubbing [Create a dubbing project from an uploaded video asset](https://developers.synthesia.io/docs/video-api-reference/dubbing/create-a-dubbing-project-from-an-uploaded-video-asset.md)
- Video API reference (v2) > Dubbing [Get dubbing project status and videos](https://developers.synthesia.io/docs/video-api-reference/dubbing/get-dubbing-project-status-and-videos.md)
- Video API reference (v2) > Dubbing [Add locales to a dubbing project (original imported video)](https://developers.synthesia.io/docs/video-api-reference/dubbing/add-locales-to-a-dubbing-project-original-imported-video.md)
- Video API reference (v2) > Assets [Create media asset](https://developers.synthesia.io/docs/video-api-reference/assets/create-media-asset.md)
- Video API reference (v2) > Assets [Get user media asset](https://developers.synthesia.io/docs/video-api-reference/assets/get-user-media-asset.md)
- Upload API reference (v2) [Upload script audio](https://developers.synthesia.io/docs/upload-api-reference/upload-script-audio.md)
- Upload API reference (v2) [Create an asset](https://developers.synthesia.io/docs/upload-api-reference/create-an-asset.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developers.synthesia.io/docs/openapi.json)
- [OpenAPI YAML](https://developers.synthesia.io/docs/openapi.yaml)