# Synthesia Documentation > Generate professional and engaging synthetic videos at-scale with Synthesia's API. ## Guides - [Video Creation](https://docs.synthesia.io/docs/video-creation.md): Create a Synthetic video with Synthesia. - [The Synthesia Editor](https://docs.synthesia.io/docs/video-edit-page.md): Use the Synthesia editor to customize, refine, and perfect every aspect of your video. - [Elements](https://docs.synthesia.io/docs/elements.md): Add Avatars, backgrounds, images, videos, text, and shapes to your scenes. - [Avatar](https://docs.synthesia.io/docs/avatar.md): Our AI avatars represent a variety of ethnicities and age groups, empowering you to create incredibly lifelike, natural, and diverse video content. - [Text](https://docs.synthesia.io/docs/text.md): Display texts in your scene. - [Shape](https://docs.synthesia.io/docs/shape.md): Add shapes to your videos for visual structure, emphasis, and design. - [Motion](https://docs.synthesia.io/docs/motion-graphics.md): Generate animated visual assets inside a scene using presets, custom prompts, or reference images. - [Media](https://docs.synthesia.io/docs/media.md): Add images, videos, animated GIFs, icons, Lottie Animations, and logos to your scenes. - [Captions](https://docs.synthesia.io/docs/captions.md): Add dynamic captions to your videos to boost engagement. - [Interactivity](https://docs.synthesia.io/docs/interactivity.md): Add buttons, quizzes, menus, and branching paths to your videos to drive higher completion rates and guide your viewers to take action. - [Record](https://docs.synthesia.io/docs/record.md): Create a screen recording in Synthesia by recording live with the AI screen recorder, or by uploading an MP4. - [Script box](https://docs.synthesia.io/docs/script.md): Add a your script to the script box to transform your text to speech and adjust the pronunciation, pacing, and emphasis of the speech as needed. - [Pronunciation Controls](https://docs.synthesia.io/docs/pronunciation-controls.md): Define how words are pronounced once — and trust them to sound right every time. - [Timeline](https://docs.synthesia.io/docs/timeline.md): Use the Timeline to control when elements appear in your scene. Layer, sequence, and fine-tune animations and effects — and edit your scene at any point in time. - [Storyboard](https://docs.synthesia.io/docs/storyboard.md): View and edit your entire video script in a continuous layout with Storyboard—designed to help you structure, refine, and improve your narrative without switching tools. - [Animations & Effects](https://docs.synthesia.io/docs/animations-and-effects.md): Apply animations and effects to avatars and elements. - [Assistant](https://docs.synthesia.io/docs/assistant.md): Assistant helps you create better videos faster through an iterative, chat-based interface directly inside Synthesia. - [Video Overview page](https://docs.synthesia.io/docs/video-overview.md): Once you generate your video, you'll have access to the video overview page. - [Video Translation](https://docs.synthesia.io/docs/video-translation.md): Translate your generated video in multiple languages to improve the reach, accessibility, and inclusiveness of your videos. - [Supported languages](https://docs.synthesia.io/docs/supported-languages.md): All languages and dialects supported for Synthesia translation feature. - [Roleplay Sessions](https://docs.synthesia.io/docs/sessions.md): Practice high-stakes conversations before they happen. - [Learner Portal](https://docs.synthesia.io/docs/learner-app.md): Manage your learners, assign Sessions to them, and track their progress. - [Learn](https://docs.synthesia.io/docs/learn.md): See what learners experience in the Learner Portal: how they find assigned Roleplay Sessions, complete them, and track their own progress and scores. - [Manage](https://docs.synthesia.io/docs/manage.md): Learn how to manage the Learner Portal—everything from publishing content, adding users, building learner groups, reviewing analytics, and connecting HRIS integrations. - [Home](https://docs.synthesia.io/docs/home-page.md): The Synthesia application home page. - [Templates](https://docs.synthesia.io/docs/synthesia-templates.md): All synthesia templates available to create amazing video - [Workspace](https://docs.synthesia.io/docs/workspaces.md): Collaborate on videos with your team in a shared workspace. - [Shared with me](https://docs.synthesia.io/docs/sharing-shared-with-me.md): All videos and folders owned by other users that have been shared with you. - [My videos](https://docs.synthesia.io/docs/my-videos-page.md): All videos owned by you. - [Trash](https://docs.synthesia.io/docs/trash.md): All recently deleted videos, folders, and templates. - [Assets](https://docs.synthesia.io/docs/assets.md) - [Library](https://docs.synthesia.io/docs/library.md): All the assets you reuse across your Synthesia videos. - [Brand kits](https://docs.synthesia.io/docs/brand-kits.md): Brand kits help you create content aligned with your company's branding by applying custom text styles, color palettes, logos, and avatars to your video - [Glossary](https://docs.synthesia.io/docs/translation-glossary.md): Manage how key terms are pronounced and translated across your Synthesia workspace. - [Avatars](https://docs.synthesia.io/docs/synthesia-avatars.md): Browse and manage custom Avatars, shared Avatars, and Synthesia stock Avatars. - [Create an Avatar](https://docs.synthesia.io/docs/personal-avatars.md): Create a digital twin that talks and looks just like you to use in your Synthesia videos. - [Studio Avatars](https://docs.synthesia.io/docs/studio-avatars.md): Get the most advanced AI Avatar created with our EXPRESS-1 model, perfectly designed for professional-quality productions. - [Voices](https://docs.synthesia.io/docs/custom-voices.md): Explore Synthesia's voice library or create your own custom voice. - [Workspace search](https://docs.synthesia.io/docs/workspace-search.md): Find any video, folder, or template across your workspace in seconds. - [Synthesia Requirements](https://docs.synthesia.io/docs/synthesia-requirements.md): OS and browser requirements to use Synthesia application. - [Keyboard Shortcuts](https://docs.synthesia.io/docs/synthesia-keyboard-shortcuts.md): All supported keyboard shortcuts for the Synthesia editor and video player. - [Need more help?](https://docs.synthesia.io/docs/need-help.md): In-app access to guides, courses, support, and more! - [AI Dubbing](https://docs.synthesia.io/docs/video-dubbing.md): Reach global audiences with AI-powered translation and dub your videos into 139 languages. - [Bulk personalization](https://docs.synthesia.io/docs/bulk-personalization.md): Create hundreds of personalized videos in bulk using CSV and XLSX files and video templates with variables. - [AI Playground](https://docs.synthesia.io/docs/ai-playground.md): The AI Playground is a dedicated tab for generating AI media — videos and images — using third-party generative models. - [User settings](https://docs.synthesia.io/docs/user-settings.md): Control your personal settings for your Synthesia account. - [Organization settings](https://docs.synthesia.io/docs/organization-settings.md): Control settings and permissions for your Synthesia organization and workspaces within it. - [Workspace Settings](https://docs.synthesia.io/docs/workspace-settings.md): Control your Synthesia workspace security, members, and Style. - [Billing & Usage](https://docs.synthesia.io/docs/billing-settings.md): Manage your Synthesia billing and usage. - [Synthesia SSO](https://docs.synthesia.io/docs/synthesia-sso-guide.md): Setup single sign-on with Synthesia. - [Just-in-Time (JIT) Provisioning](https://docs.synthesia.io/docs/jit-provisioning.md): Automatically onboard users from your domain—no manual invites required. - [User roles & permissions](https://docs.synthesia.io/docs/user-roles-and-permissions.md): Manage user roles and their associated permissions. - [User licenses](https://docs.synthesia.io/docs/user-licenses.md): Manage Synthesia user licenses - [Audit logs](https://docs.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. - [Synthesia integrations](https://docs.synthesia.io/docs/synthesia-integrations.md) - [360Learning](https://docs.synthesia.io/docs/360learning.md): Embed Synthesia videos in 360Learning courses to scale training content with minimal effort and high quality. - [aNewSpring](https://docs.synthesia.io/docs/anewspring.md): Embed Synthesia videos into aNewSpring courses to enhance your learning content with AI-generated videos. - [Articulate 360](https://docs.synthesia.io/docs/articulate-360.md): Embed Synthesia videos into Articulate 360 courses to enhance your learning content with AI-generated videos. - [Big Commerce](https://docs.synthesia.io/docs/big-commerce.md): Embed Synthesia videos into BigCommerce to improve engagement and increase conversion on product and landing pages. - [Blanc](https://docs.synthesia.io/docs/blanc.md): Use Blanc to translate and redub Synthesia videos into any language in seconds—no editing or re-recording required. - [ChurnZero](https://docs.synthesia.io/docs/churnzero.md): Embed Synthesia videos in ChurnZero messages to deliver personalized, scalable customer engagement across onboarding, training, and retention workflows. - [Coassemble](https://docs.synthesia.io/docs/coassemble.md): Embed Synthesia videos into Coassemble courses to deliver AI-generated learning content quickly and effectively. - [Continu](https://docs.synthesia.io/docs/continu.md): Continu and Synthesia have partnered to make professional video creation fast, scalable, and effortless for modern learning teams. Create AI-generated training videos in minutes inside Synthesia and deploy them directly into your Continu courses - no cameras, studios, or video editing skills required. - [Crowdin](https://docs.synthesia.io/docs/crowdin.md): Integrate Crowdin with Synthesia to automate translation workflows and produce localized videos at scale. Combine AI-driven translation with human review and push finished translations directly back into Synthesia. - [Disco](https://docs.synthesia.io/docs/disco.md): Create AI-powered learning videos in Synthesia, publish in Disco—all in one seamless flow. - [Docebo](https://docs.synthesia.io/docs/docebo.md): Embed Synthesia videos into Docebo to deliver high-quality, AI-generated learning content that goes beyond standard LMS capabilities. - [eloomi](https://docs.synthesia.io/docs/eloomi.md): Embed Synthesia videos in eloomi courses to replace face-to-face training with high-quality, AI-generated learning content. - [ETU](https://docs.synthesia.io/docs/etu.md): Upload Synthesia videos into ETU simulations to deliver realistic training experiences using AI-generated presenters. - [Easygenerator](https://docs.synthesia.io/docs/easygenerator.md): Combine Synthesia videos with Easygenerator to create high-quality video-based courses, even with no prior e-learning experience. - [Eduflow](https://docs.synthesia.io/docs/eduflow.md): Use Synthesia videos in Eduflow to create interactive, on-demand courses with minimal production overhead. - [Excel Add-in](https://docs.synthesia.io/docs/excel-add-in.md): Easily turn spreadsheet data into personalized videos—right inside Excel. Create engaging, scalable videos from rows of data without leaving their existing workflow. - [FlowShare](https://docs.synthesia.io/docs/flowshare.md): Connect FlowShare with Synthesia to turn step-by-step workflows into professionally narrated AI-generated videos in minutes. - [HiBob](https://docs.synthesia.io/docs/hibob.md): Connect HiBob to Synthesia to keep your Learner Portal in sync with your HR system — employees from a HiBob report are added as learners automatically, and refreshed every day. - [HubSpot](https://docs.synthesia.io/docs/hubspot.md): Embed Synthesia videos into your HubSpot Knowledge Base articles to make answers more engaging and easier to follow. - [Intercom](https://docs.synthesia.io/docs/intercom.md): Easily embed Synthesia videos into Intercom to create more engaging and interactive customer support experiences. - [Kaltura](https://docs.synthesia.io/docs/kaltura.md): Kaltura and Synthesia have joined forces to offer customers an end-to-end solution for creating, managing, and distributing AI-generated video content at scale. - [Kickstarter](https://docs.synthesia.io/docs/kickstarter.md): Use Synthesia videos on Kickstarter to tell your project’s story with emotion, personality, and clarity—without cameras or studios. - [KnowBe4](https://docs.synthesia.io/docs/knowbe4.md): KnowBe4 and Synthesia have partnered to make professional video creation fast, scalable, and effortless for modern learning teams. Create AI-generated training videos in minutes inside Synthesia and publish them directly into KnowBe4 as SCORM 2004 courses — no cameras, studios, or video editing skills required. - [Kumullus](https://docs.synthesia.io/docs/kumullus.md): Sync your Synthesia video library with Kumullus to build high-quality, interactive training modules with AI-generated video. - [Lectora](https://docs.synthesia.io/docs/lectora.md): Add Synthesia videos to Lectora to build comprehensive, media-rich eLearning courses using one of the most flexible authoring tools on the market. - [Make](https://docs.synthesia.io/docs/make.md): Automate your workflows by connecting Synthesia to hundreds of apps using Make’s drag-and-drop visual builder—no coding required. - [Medium](https://docs.synthesia.io/docs/medium.md): Transform text-based Medium stories into engaging video experiences by embedding Synthesia videos directly into your posts. - [Mindstamp](https://docs.synthesia.io/docs/mindstamp.md): Use the Mindstamp integration to add interactive elements like buttons, questions, and branching to your Synthesia videos—without leaving the platform. - [Mini Course Generator](https://docs.synthesia.io/docs/mini-course-generator.md): Use Synthesia to create short, clear AI-generated videos and embed them into micro-learning experiences using Mini Course Generator’s drag-and-drop interface. - [Monday.com](https://docs.synthesia.io/docs/monday.md): Embed Synthesia videos in Monday.com dashboards to present ideas and updates in a more engaging, visual format—right where your team works. - [Moodle](https://docs.synthesia.io/docs/moodle.md): Embed Synthesia videos into Moodle courses to deliver AI-generated training content quickly and seamlessly. - [Microsoft Teams](https://docs.synthesia.io/docs/microsoft-teams.md): Follow this documentation in order to configure the Synthesia Teams Notification Application in your Azure Tenant - [Notion](https://docs.synthesia.io/docs/notion.md): Embed Synthesia videos in Notion to bring project updates, documentation, and team communication to life—directly inside your workspace. - [ParcOOroo](https://docs.synthesia.io/docs/parcooroo.md): Create free, blended, or remote video courses by embedding Synthesia videos directly into your ParkOOroo learning platform. - [PowerPoint](https://docs.synthesia.io/docs/powerpoint.md): Convert PowerPoint presentations into engaging AI-narrated videos using Synthesia. - [SAP Litmos](https://docs.synthesia.io/docs/sap-litmos.md): Embed Synthesia videos into SAP Litmos to build polished, video-driven training courses for employee onboarding, compliance, and upskilling. - [Shopify](https://docs.synthesia.io/docs/shopify.md): Embed Synthesia videos into Shopify product or landing pages to increase customer engagement and boost conversion rates. - [Squarespace](https://docs.synthesia.io/docs/squarespace.md): Use Synthesia to create landing page and explainer videos with AI avatars, then embed them in Squarespace to boost engagement and conversions. - [Stellar Labs](https://docs.synthesia.io/docs/stellar-labs.md): Use Synthesia videos in Stellar Labs to enhance learning journeys with engaging, on-the-job training content powered by AI. - [TalentLMS](https://docs.synthesia.io/docs/talentlms.md): Embed Synthesia videos in TalentLMS courses to deliver high-quality, AI-generated learning content directly within your training modules. - [Thinkific](https://docs.synthesia.io/docs/thinkific.md): Use Synthesia and Thinkific together to create and deliver high-quality online courses with engaging AI-generated videos. - [Thought Industries](https://docs.synthesia.io/docs/thoughtindustries.md): Easily embed Synthesia videos in Thought Industries to create more engaging and interactive learning experiences. - [Tolstoy](https://docs.synthesia.io/docs/tolstoy.md): Connect Synthesia with Tolstoy to embed AI-generated videos directly into interactive video experiences, ideal for websites, email campaigns, and customer journeys. - [uQualio](https://docs.synthesia.io/docs/uqualio.md): Use Synthesia with uQualio to scale your video-based training programs by embedding AI-generated micro-learning content directly into uQualio. - [Udemy](https://docs.synthesia.io/docs/udemy.md): Integrate Synthesia with Udemy to produce professional course videos faster, in 140+ languages, and without the need for cameras or post-production. - [Unsplash](https://docs.synthesia.io/docs/unsplash.md): Easily add high-resolution, royalty-free images to your Synthesia videos using Unsplash to improve visual clarity and engagement. - [Userpilot](https://docs.synthesia.io/docs/userpilot.md): Use Synthesia videos in Userpilot to deliver personalized, in-app onboarding and product education experiences, without writing code. - [Vimeo](https://docs.synthesia.io/docs/vimeo.md): Export Synthesia videos in MP4 format and upload them to Vimeo for global sharing, embedding, and distribution across platforms. - [Wisetail](https://docs.synthesia.io/docs/wisetail.md): Deliver AI-powered training at scale by embedding Synthesia videos directly into Wisetail’s learning modules and media library. - [WordPress](https://docs.synthesia.io/docs/wordpress.md): Embed Synthesia videos into WordPress pages or posts in just a few clicks to boost engagement and increase conversions. - [Workato](https://docs.synthesia.io/docs/workato.md): Use the Synthesia Workato Connector—developed by Solomon Consulting Group—to automate the creation of AI-generated videos directly from Workato workflows. - [Workday](https://docs.synthesia.io/docs/workday.md): Learn how to connect Workday to Synthesia and sync employees into your Learner Portal automatically. Keep learners up to date daily with a Workday report. - [YouTube](https://docs.synthesia.io/docs/youtube.md): Download and upload Synthesia videos to YouTube in Full HD 1080p to share your content with the world in just minutes. - [Zngly](https://docs.synthesia.io/docs/zngly.md): Streamline your sales and marketing workflows by embedding Synthesia videos into Zngly’s centralized content hub, complete with robust organization and analytics tools. - [Multilingual Video Player](https://docs.synthesia.io/docs/video-player.md): Synthesia's responsive video player supports playback for multiple translations of a single video from within a single video player, with chapters, captions, and intuitive player controls, no matter what device they're watching your video on. - [Chapters](https://docs.synthesia.io/docs/chapters.md): With Chapters, you can provide an easier way for your viewers to understand and navigate your videos, improving their viewing experience (and your engagement metrics). ## API Reference - [Introduction](https://docs.synthesia.io/reference/introduction.md): Reference documentation about Synthesia's API. - [API Quickstart](https://docs.synthesia.io/reference/synthesia-api-quickstart.md): Create your first video with Synthesia API - [Guide: Create a video from a template](https://docs.synthesia.io/reference/guide-create-a-video-from-template.md): Automatically produce personalized, professional-looking video content with API templates. - [Guide: Zapier integration](https://docs.synthesia.io/reference/guide-synthesia-zapier.md): Set up the world's first automatic video personalization flows with Synthesia and Zapier. No coding required. - [Guide: Dub your videos via Synthesia API](https://docs.synthesia.io/reference/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. - [Templates](https://docs.synthesia.io/reference/templates.md) - [List templates](https://docs.synthesia.io/reference/list-templates.md): Use the List templates endpoint to get an overview of all templates in Synthesia STUDIO, as well as the variables that may be provided when using them. - [Retrieve a template](https://docs.synthesia.io/reference/retrieve-a-template.md): You can use Retrieve a template endpoint to pull information on a template. In particular, you may use it to find out the variables available for customisation. - [Videos](https://docs.synthesia.io/reference/videos.md) - [Create a video](https://docs.synthesia.io/reference/create-video.md): Create a video within your Synthesia account. To get started on this endpoint check the [API Quickstart guide](https://docs.synthesia.io/reference/synthesia-api-quickstart). - [Create a video from a template](https://docs.synthesia.io/reference/create-a-video-from-a-template.md): Create a video based on a template created in Synthesia. - [List videos](https://docs.synthesia.io/reference/list-videos.md): You can use the List videos endpoint to get an overview of all videos created via the API or STUDIO. - [Retrieve a video](https://docs.synthesia.io/reference/retrieve-a-video.md): You can use Retrieve a video endpoint to pull for the video status. - [Retrieve a thumbnail](https://docs.synthesia.io/reference/retrieve-a-jpg-thumbnail.md): Use this endpoint to pull information on a given video thumbnail. - [Retrieve a GIF thumbnail](https://docs.synthesia.io/reference/retrieve-a-gif-thumbnail.md): Use this endpoint to pull information on a given video GIF thumbnail. - [Retrieve a GIF/JPG thumbnail](https://docs.synthesia.io/reference/retrieve-a-gif-jpg-thumbnail.md): Use this endpoint to pull information on a given video. It will return a GIF thumbnail if it exists, otherwise a JPG. - [Update a video](https://docs.synthesia.io/reference/update-a-video.md): Use the Update a video endpoint to make the video public and accessible via the share page or update its title and description. - [Delete a video](https://docs.synthesia.io/reference/delete-a-video.md): Use this endpoint to delete videos. - [Create a dubbing project from an uploaded video asset](https://docs.synthesia.io/reference/create-a-dubbing-project.md): Use this endpoint to create a dubbing project from an uploaded video asset. Currently only S3 signed URLs are supported (using other URLs will return a `501` error) - [Get dubbing project status and videos](https://docs.synthesia.io/reference/get-dubbing-project-status-and-videos.md): Retrieve the status of a dubbing project and its dubbed videos. **Status values:** - `uploading`: The source video is still being uploaded/processed (only for projects created via sourceVideoUrl) - `in_progress`: Dubbing is in progress - `complete`: All dubbing is complete - `error`: An error occurred during dubbing **Response varies by status:** - UPLOADING: Returns only id and status - IN_PROGRESS/COMPLETE: Returns id, status, and dubbedAssets array - ERROR: Returns id, status, and errorCode **Dubbed asset status:** - IN_PROGRESS: Returns minimal data (id, language, status) - COMPLETE: Returns full data including download URLs - ERROR: Returns minimal data plus errorCode - [Add locales to a a dubbing project (original imported video)](https://docs.synthesia.io/reference/add-locales-to-a-dubbing-project.md): Add the passed target locales to a dubbing project (original imported video). If a target locale is already added, it will be skipped. - [Translate and generate a video from XLIFF definition](https://docs.synthesia.io/reference/xliff-import.md): Given XLIFF content, translate and generate a video. - [Retrieve XLIFF content for a video](https://docs.synthesia.io/reference/xliff-export.md): You can use Retrieve XLIFF content endpoint to pull the XLIFF specification for a given video containing all the text content (script, chapters, text elements). - [Get supported languages for translations](https://docs.synthesia.io/reference/get-supported-languages-for-translations.md): Get a list of supported languages for translations. - [Start/Update a video translation](https://docs.synthesia.io/reference/put_v2-translations-root-video-id.md): Kick off TranslateVideoWorkflow for each requested target language. Returns a unified `translations` list. Each entry includes a `startedByRequest` flag: `true` if the workflow was started by this request, `false` if it was already in progress. - [Webhooks](https://docs.synthesia.io/reference/webhooks.md) - [Delete a webhook](https://docs.synthesia.io/reference/delete-a-webhook.md): Use this endpoint to delete videos. - [Retrieve a webhook](https://docs.synthesia.io/reference/retrieve-a-webhook.md): Retrieve a webhook endpoint to pull for the webhook status. - [List webhooks](https://docs.synthesia.io/reference/list-webhooks.md): List all currently configured webhooks in your Synthesia account. - [Create a Webhook](https://docs.synthesia.io/reference/create-a-webhook.md): Use the Create a webhook endpoint to create a new event subscription. - [Audit Logs](https://docs.synthesia.io/reference/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. - [Query audit log events](https://docs.synthesia.io/reference/retrieve-audit-log-events.md): Retrieve paginated audit log events for a workspace or an organization. Exactly one of workspaceId or organizationId must be provided. Supports filtering by date range (Unix timestamps), multiple actions, multiple actor IDs, and target ID. Any combination of filters can be applied together. **Array parameters use comma-separated values:** - Multiple actions: `?actions=billing.credits.consumed,dubbing.project.created` - Multiple actors: `?actorIds=user-123,user-456` Example queries: - Latest events: `GET /v2/auditLogs/events?workspaceId=12345678-1234-1234-1234-123456789abc&limit=50` - Filtered by action and date: `GET /v2/auditLogs/events?workspaceId=12345678-1234-1234-1234-123456789abc` `&actions=billing.credits.consumed&startDate=1704067200&endDate=1706745599` - Multiple filters: `GET /v2/auditLogs/events?workspaceId=12345678-1234-1234-1234-123456789abc` `&actions=billing.credits.consumed,dubbing.project.created&actorIds=user-123,user-456` This endpoint is rate-limited and usage is tracked against your API quota. - [Search audit log events (Advanced)](https://docs.synthesia.io/reference/search-audit-log-events.md): Advanced search endpoint for audit log events with complex filter criteria. **For most use cases, use GET /v2/auditLogs/events instead.** Use this endpoint when: - Filtering by 50+ actions or actors - Complex query logic (future enhancement) - Programmatic access requiring JSON request bodies Exactly one of workspaceId or organizationId must be provided. Supports filtering by date range (Unix timestamps), multiple actions, multiple actor IDs, and target ID. Any combination of filters can be applied together. Example request body for January 2024 user login events: { "workspaceId": "12345678-1234-1234-1234-123456789abc", "actions": ["user.authentication.login"], "startDate": 1704067200, "endDate": 1706745599 } This endpoint is rate-limited and usage is tracked against your API quota. - [Export audit log events as CSV](https://docs.synthesia.io/reference/export-audit-log-events-as-csv.md): Export audit log events for a workspace or organization as a CSV file. Exactly one of workspaceId or organizationId must be provided. Supports the same filtering options as the query endpoints: - Date range (Unix timestamps) - Multiple actions - Multiple actor IDs - Target ID **Export limits:** - Maximum 10,000 events per export - If more events match the filters, the export will be truncated - Truncated exports include "_TRUNCATED" in the filename **Example requests:** - Export all events for an organization: {"organizationId": "12345678-1234-1234-1234-123456789abc"} - Export filtered events: {"organizationId": "12345678-1234-1234-1234-123456789abc", "startDate": 1704067200, "endDate": 1735689599, "actions": ["billing.credits.consumed", "video.created"]} - Export by workspace with filters: {"workspaceId": "12345678-1234-1234-1234-123456789abc", "actorIds": ["user-123", "user-456"]} This endpoint is rate-limited and usage is tracked against your API quota. - [Assets](https://docs.synthesia.io/reference/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**. - [Create media asset](https://docs.synthesia.io/reference/create-media-asset.md): Creates a media asset with support for multipart or direct url upload. This endpoint currently supports only the dubbing configuration. - [Get user media asset](https://docs.synthesia.io/reference/get-user-media-asset.md): Retrieves a user uploaded media asset by its ID. Returns the asset's status, title, content type, and metadata including detected language if available. Currently only supports user-uploaded assets in the dubbing configuration. - [Create an asset](https://docs.synthesia.io/reference/create-an-asset.md): An asset is an image or video which you would like to include in a generated video. Image and video assets may be used as a background or as an element on the canvas. - [Upload script audio](https://docs.synthesia.io/reference/upload-script-audio.md): Use this endpoint to upload the script audio. These may then be later referred to when creating videos. - [List of supported voices](https://docs.synthesia.io/reference/voices.md): Supported voices by the Synthesia API with their associated IDs . - [List of stock avatars](https://docs.synthesia.io/reference/avatars.md): Supported avatars by the Synthesia API with their associated IDs . - [Webhook events](https://docs.synthesia.io/reference/webhook-events.md): Webhook events supported by Synthesia - [Verifying Synthesia Signatures](https://docs.synthesia.io/reference/verifying-synthesia-signatures.md) - [Script supported XML tags](https://docs.synthesia.io/reference/script-supported-xml-tags.md): List of supported XML tags for Synthesia scripts. ## Changelog - [New Dubbing & Assets APIs](https://docs.synthesia.io/changelog/new-dubbing-assets-apis.md) - [API Improvements](https://docs.synthesia.io/changelog/api-improvements-1.md) - [API Improvements](https://docs.synthesia.io/changelog/api-improvements.md) - [API Improvements](https://docs.synthesia.io/changelog/api-improvements-august.md) - [Synthesia APIs are generally available](https://docs.synthesia.io/changelog/synthesia-apis-are-generally-available.md)