> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Lip-sync a translated video > Generate lip sync from a completed translation version using its stored media. Supports standard, pro and studio modes subject to the plan and normal media credits. Poll projects_status. Generate lip sync from a completed translation version using its stored media. Supports standard, pro and studio modes subject to the plan and normal media credits. Poll projects\_status. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/lipsync_create ``` ## Authentication and permissions Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by MCP, not by this REST endpoint. Required permissions: `translations:write`. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits. ## Parameters Text value. Minimum length: 1. Maximum length: 200. Pattern: `^[^/\\]+$`. Text value. Minimum length: 1. Maximum length: 200. Pattern: `^[^/\\]+$`. Text value. Minimum length: 1. Maximum length: 200. Pattern: `^[^/\\]+$`. Text value. Allowed values: "standard", "pro", "studio". Default: "standard". Boolean value. Default: false. Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response. Format: "uuid". Pattern: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`. The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes. ```json theme={null} { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^/\\\\]+$" }, "workId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^/\\\\]+$" }, "translatedVersionId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^/\\\\]+$" }, "lipSyncMode": { "default": "standard", "type": "string", "enum": ["standard", "pro", "studio"] }, "activeSpeakerDetectionEnabled": { "default": false, "type": "boolean" }, "requestId": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries." } }, "required": ["projectId", "workId", "translatedVersionId"], "additionalProperties": false } ``` ## Idempotency Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically. Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action. ## Request examples Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/lipsync_create' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"projectId":"project_launch_2026","workId":"5f8423d1-e4c0-4f80-9e3f-eed959389e24","translatedVersionId":"0fa684f3-4997-4d7a-9424-16d1f9ac849c","lipSyncMode":"standard","activeSpeakerDetectionEnabled":false,"requestId":"41321bda-e243-4b6f-96a4-622cd047c991"}' ``` ```javascript JavaScript theme={null} const input = { projectId: 'project_launch_2026', workId: '5f8423d1-e4c0-4f80-9e3f-eed959389e24', translatedVersionId: '0fa684f3-4997-4d7a-9424-16d1f9ac849c', lipSyncMode: 'standard', activeSpeakerDetectionEnabled: false, requestId: '41321bda-e243-4b6f-96a4-622cd047c991', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/lipsync_create', { method: 'POST', headers: { 'x-api-key': process.env.VOICECHEAP_API_KEY, 'Content-Type': 'application/json', }, body: JSON.stringify(input), }); const body = await response.json(); if (!response.ok) throw new Error(body.code + ': ' + body.message); console.log(body); ``` ```python Python theme={null} import os import requests response = requests.post( "https://api.voicecheap.ai/v1/actions/lipsync_create", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24", "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c", "lipSyncMode": "standard", "activeSpeakerDetectionEnabled": False, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## Response This operation returns HTTP 202 while running. Save requestId and poll action\_request\_get with that identifier and the original operation name. Polling states are running, completed, failed, and interrupted. A completed result can point to a separate media job; continue with the operation-specific status or output action. Returns the selected project, work and version identifiers with processing status after admitting lip sync. ```json HTTP 202 theme={null} { "data": { "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "status": "running", "pollAction": "action_request_get", "pollAfterSeconds": 5 }, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991" } ``` ```json HTTP 200 theme={null} { "data": { "projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24", "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c", "status": "processing" }, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "operation": "lipsync_create", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "operation": "lipsync_create", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991" } ``` ## Result fields | Field | Description | | - | - | | `data.projectId` | Parent project identifier. | | `data.workId` | Authorized language-work identifier. | | `data.translatedVersionId` | Selected completed translated version. | | `data.status` | processing after the downstream request was admitted; output completion must be polled separately. | ## Recover and poll this request Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress. ```bash theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"41321bda-e243-4b6f-96a4-622cd047c991","operation":"lipsync_create"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "operation": "lipsync_create", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24", "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c", "status": "processing" } } } ``` ## Operation notes * The selected translated version must be completed and have both stored video and audio URLs. Caller-supplied video or audio URLs are not accepted. * lipSyncMode defaults to standard and accepts standard, pro or studio. Plan access, duration and media credit checks still apply. activeSpeakerDetectionEnabled defaults to false. * This is a long-running action. First poll action\_request\_get for this operation's handler result; afterward poll projects\_status or projects\_get for lip-sync completion and its output URL. * The handler result contains no lip-sync jobId or video URL. projects\_get.translations\[].lipSync provides the public latest entry and history. * The authenticated actor retains project access checks; project billing ownership does not grant access to another member's private projects. ## Usage Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply. ## Errors | HTTP status | Code | Meaning or recovery | | - | - | - | | 400 | `BAD_REQUEST` | The submitted stored video has missing or invalid duration, or exceeds the mode duration limit. | | 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. | | 400 | `IDEMPOTENCY_CONFLICT` | The Idempotency-Key header and requestId body field must match. | | 400 | `INVALID_REQUEST_ID` | Supply a UUID v4 requestId or Idempotency-Key. | | 400 | `TRANSLATION_NOT_READY` | The selected version is not completed or lacks stored video or audio. | | 400 | `VALIDATION_ERROR` | Correct the input using the schema. Invalid or inconsistent values are rejected before execution. | | 401 | `API_KEY_EXPIRED` | The API key has expired. | | 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. | | 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. | | 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. | | 401 | `UNAUTHORIZED` | The current account lacks mode access, available lip-sync usage or sufficient media credits. | | 401 | `USER_NOT_FOUND` | The credential's account no longer exists. | | 403 | `ACCOUNT_UNAVAILABLE` | The acting or billing account is unavailable or being deleted. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. | | 403 | `FORBIDDEN` | The authenticated actor cannot access this project. | | 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. | | 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. | | 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. | | 404 | `PROJECT_NOT_FOUND` | The project does not exist in the accessible account. | | 404 | `TRANSLATION_NOT_FOUND` | workId does not identify a language work owned by this project. | | 404 | `TRANSLATION_VERSION_NOT_FOUND` | translatedVersionId does not belong to the selected language work. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | This account already has 10 integration actions running. Poll an existing request before starting another. | | 409 | `CONFLICT` | The selected translation media changed before lip sync could start. | | 409 | `IDEMPOTENCY_CONFLICT` | Reuse an identifier only with the same operation and arguments. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. | | 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. | | 503 | `ACTION_RESULT_UNAVAILABLE` | The action ran but its result could not be saved. Inspect saved request state and resource history before starting a new generation. | | 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["translations:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.