> ## 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.
# Een vertaalde video lipsynchroniseren
> Genereer lipsynchronisatie op basis van de opgeslagen media van een voltooide vertaalversie. Ondersteunt de modi standard, pro en studio, afhankelijk van het abonnement en met het gebruikelijke mediategoed. Controleer projects_status.
Genereer lipsynchronisatie op basis van de opgeslagen media van een voltooide vertaalversie. Ondersteunt de modi standard, pro en studio, afhankelijk van het abonnement en met het gebruikelijke mediategoed. Controleer projects\_status.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/lipsync_create
```
## Authenticatie en machtigingen
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
Vereiste machtigingen: `translations:write`.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
## Parameters
Tekstwaarde.
Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/\\]+$`.
Tekstwaarde.
Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/\\]+$`.
Tekstwaarde.
Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/\\]+$`.
Tekstwaarde.
Toegestane waarden: "standard", "pro", "studio". Standaardwaarde: "standard".
Booleaanse waarde.
Standaardwaarde: false.
Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.
Formaat: "uuid". Patroon: `^[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}$`.
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.
```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
}
```
## Idempotentie
Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart.
Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.
## Voorbeeldaanvragen
Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.
```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)
```
## Antwoord
Deze bewerking retourneert HTTP 202 zolang deze wordt uitgevoerd. Bewaar requestId en controleer action\_request\_get met die identificatie en de oorspronkelijke bewerkingsnaam. De mogelijke statussen zijn running, completed, failed en interrupted. Een voltooid resultaat kan naar een afzonderlijke mediataak verwijzen; ga dan verder met de status- of uitvoeractie van die bewerking.
Retourneert de geselecteerde project-, taalversie- en uitvoerversie-ID's met de verwerkingsstatus nadat lipsynchronisatie is toegelaten.
```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"
}
```
## Resultaatvelden
| Veld | Beschrijving |
| - | - |
| `data.projectId` | ID van het bovenliggende project. |
| `data.workId` | Identificatie van een geautoriseerde taalversie. |
| `data.translatedVersionId` | Geselecteerde voltooide vertaalversie. |
| `data.status` | processing nadat de downstreamaanvraag is toegelaten; de voltooiing van de uitvoer moet afzonderlijk worden opgevraagd. |
## Deze aanvraag herstellen en controleren
Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.
```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"
}
}
}
```
## Opmerkingen bij de bewerking
* De geselecteerde vertaalversie moet de status completed hebben en zowel een opgeslagen video-URL als audio-URL hebben. Door de aanroeper aangeleverde video- of audio-URL's worden niet geaccepteerd.
* lipSyncMode is standaard standard en accepteert standard, pro of studio. Controles op abonnementstoegang, duur en mediategoed blijven gelden. activeSpeakerDetectionEnabled is standaard false.
* Dit is een langdurige actie. Poll eerst action\_request\_get voor het handlerresultaat van deze bewerking; poll daarna projects\_status of projects\_get om te zien of de lipsynchronisatie is voltooid en de uitvoer-URL op te halen.
* Het handlerresultaat bevat geen jobId voor lipsynchronisatie of video-URL. projects\_get.translations\[].lipSync biedt de openbare recentste vermelding en geschiedenis.
* De geauthenticeerde uitvoerende gebruiker blijft onderworpen aan projecttoegangscontroles; eigenaarschap van de projectfacturering geeft geen toegang tot privéprojecten van een ander lid.
## Verbruik
Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.
## Fouten
| HTTP-status | Code | Betekenis of herstel |
| - | - | - |
| 400 | `BAD_REQUEST` | De ingediende opgeslagen video heeft een ontbrekende of ongeldige duur, of overschrijdt de duurlimiet van de modus. |
| 400 | `CREDENTIAL_IN_QUERY` | Inloggegevens zijn opgegeven in een queryparameter access\_token of api\_key. Stuur inloggegevens in headers. |
| 400 | `IDEMPOTENCY_CONFLICT` | De header Idempotency-Key en het bodyveld requestId moeten overeenkomen. |
| 400 | `INVALID_REQUEST_ID` | Geef een UUID v4 op als requestId of Idempotency-Key. |
| 400 | `TRANSLATION_NOT_READY` | De geselecteerde versie is niet voltooid of heeft geen opgeslagen video of audio. |
| 400 | `VALIDATION_ERROR` | Corrigeer de invoer aan de hand van het schema. Ongeldige of tegenstrijdige waarden worden vóór de uitvoering geweigerd. |
| 401 | `API_KEY_EXPIRED` | De API-sleutel is verlopen. |
| 401 | `INVALID_API_KEY` | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | `INVALID_CREDENTIAL` | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | `UNAUTHORIZED` | Het huidige account heeft geen toegang tot de modus, geen beschikbaar lipsynchronisatiegebruik of onvoldoende mediategoed. |
| 401 | `USER_NOT_FOUND` | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | `ACCOUNT_UNAVAILABLE` | Het uitvoerende of factureringsaccount is niet beschikbaar of wordt verwijderd. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | `FORBIDDEN` | De geauthenticeerde uitvoerende gebruiker heeft geen toegang tot dit project. |
| 403 | `INSUFFICIENT_SCOPE` | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | `SUBSCRIPTION_REQUIRED` | Gebruik een actief betaald abonnement. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 404 | `PROJECT_NOT_FOUND` | Het project bestaat niet in het toegankelijke account. |
| 404 | `TRANSLATION_NOT_FOUND` | workId identificeert geen taalversie die bij dit project hoort. |
| 404 | `TRANSLATION_VERSION_NOT_FOUND` | translatedVersionId hoort niet bij de geselecteerde taalversie. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start. |
| 409 | `CONFLICT` | De geselecteerde vertaalmedia zijn gewijzigd voordat de lipsynchronisatie kon starten. |
| 409 | `IDEMPOTENCY_CONFLICT` | Gebruik een identificatie alleen opnieuw met dezelfde bewerking en argumenten. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | `INTERNAL_ERROR` | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | De actie is uitgevoerd, maar het resultaat kon niet worden opgeslagen. Controleer de opgeslagen aanvraagstatus en resourcegeschiedenis voordat je een nieuwe generatie start. |
| 503 | `SERVER_RESTARTING` | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |
```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.