curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_add' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","targetLanguage":"english","requestId":"41321bda-e243-4b6f-96a4-622cd047c991"}'
const input = {
projectId: 'project_launch_2026',
targetLanguage: 'english',
requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_add', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/translations_add",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "targetLanguage": "english", "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)
{
"data": {
"projectId": "project_launch_2026",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"targetLanguage": "english"
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_add",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_add",
"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"
}
Vertaling en nasynchronisatie
Een doeltaal toevoegen
Voeg een lege taalversie voor een doeltaal toe aan een bestaand project zonder betaalde mediageneratie te starten.
POST
/
v1
/
actions
/
translations_add
curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_add' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","targetLanguage":"english","requestId":"41321bda-e243-4b6f-96a4-622cd047c991"}'
const input = {
projectId: 'project_launch_2026',
targetLanguage: 'english',
requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_add', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/translations_add",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "targetLanguage": "english", "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)
{
"data": {
"projectId": "project_launch_2026",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"targetLanguage": "english"
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_add",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_add",
"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"
}
Voeg een lege taalversie voor een doeltaal toe aan een bestaand project zonder betaalde mediageneratie te starten.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/translations_add
Authenticatie en machtigingen
string
vereist
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.
translations:write.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
string
vereist
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 200. Patroon:
^[^/\\]+$.string
vereist
Tekstwaarde.Toegestane waarden: “afrikaans”, “albanian”, “amharic”, “arabic”, “armenian”, “assamese”, “azerbaijani”, “basque”, “belarusian”, “bengali”, “bosnian”, “bulgarian”, “catalan”, “croatian”, “czech”, “danish”, “dutch”, “english”, “british english”, “estonian”, “finnish”, “french”, “french canadian”, “galician”, “german”, “greek”, “gujarati”, “hebrew”, “hindi”, “hungarian”, “icelandic”, “indonesian”, “irish”, “italian”, “japanese”, “kannada”, “kazakh”, “khmer”, “korean”, “lao”, “latvian”, “lithuanian”, “macedonian”, “malay”, “malayalam”, “mandarin”, “marathi”, “mongolian”, “nepali”, “norwegian”, “persian”, “polish”, “portuguese”, “brazilian portuguese”, “pt_brazil”, “punjabi”, “romanian”, “russian”, “serbian”, “slovak”, “slovenian”, “spanish”, “swahili”, “swedish”, “tagalog”, “tamil”, “telugu”, “thai”, “turkish”, “ukrainian”, “urdu”, “vietnamese”, “welsh”, “yoruba”, “zulu”.
string
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}$.Volledig invoerschema
Volledig invoerschema
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.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"targetLanguage": {
"type": "string",
"enum": [
"afrikaans",
"albanian",
"amharic",
"arabic",
"armenian",
"assamese",
"azerbaijani",
"basque",
"belarusian",
"bengali",
"bosnian",
"bulgarian",
"catalan",
"croatian",
"czech",
"danish",
"dutch",
"english",
"british english",
"estonian",
"finnish",
"french",
"french canadian",
"galician",
"german",
"greek",
"gujarati",
"hebrew",
"hindi",
"hungarian",
"icelandic",
"indonesian",
"irish",
"italian",
"japanese",
"kannada",
"kazakh",
"khmer",
"korean",
"lao",
"latvian",
"lithuanian",
"macedonian",
"malay",
"malayalam",
"mandarin",
"marathi",
"mongolian",
"nepali",
"norwegian",
"persian",
"polish",
"portuguese",
"brazilian portuguese",
"pt_brazil",
"punjabi",
"romanian",
"russian",
"serbian",
"slovak",
"slovenian",
"spanish",
"swahili",
"swedish",
"tagalog",
"tamil",
"telugu",
"thai",
"turkish",
"ukrainian",
"urdu",
"vietnamese",
"welsh",
"yoruba",
"zulu"
]
},
"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", "targetLanguage"],
"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.curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_add' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","targetLanguage":"english","requestId":"41321bda-e243-4b6f-96a4-622cd047c991"}'
const input = {
projectId: 'project_launch_2026',
targetLanguage: 'english',
requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_add', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/translations_add",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "targetLanguage": "english", "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
Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Retourneert een nieuwe taalversie-ID, of de volledige projectie van de bestaande taalversie wanneer die doeltaal al bestaat.{
"data": {
"projectId": "project_launch_2026",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"targetLanguage": "english"
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_add",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_add",
"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.workId | Identificatie van de taalversie. |
data.projectId | ID van het bovenliggende project. |
data.targetLanguage | Doeltaal. |
data.originalLanguage | Brontaal. |
data.createdAt | Aanmaaktijdstip van de taalversie, genormaliseerd naar Unix-milliseconden. |
data.isWorkWaitingForProofreading | Tekstcontrolestatus; false wanneer niet expliciet ingesteld. |
data.pendingSegmentIndexes | Bronsegmentindexen die nog wachten op vertaling, standaard een lege array. |
data.versions | Alle openbare versies in deze taalversie, van nieuw naar oud gesorteerd. |
data.versions[].workId | Identificatie van de taalversie die deze versie bevat. |
data.versions[].translatedVersionId | Identificatie van een specifieke uitvoerversie van de nasynchronisatie. |
data.versions[].targetLanguage | Doeltaal van de versie, met de taalversie als terugval. |
data.versions[].status | Opgeslagen versiestatus: not-started, in-progress, completed of failed. |
data.versions[].currentStep | Optionele stap in de nasynchronisatiepipeline; progress is een optionele numerieke voortgangswaarde. |
data.versions[].progress | Optionele voortgangswaarde voor nasynchronisatie. |
data.versions[].createdAt | Aanmaaktijd genormaliseerd tot Unix-milliseconden; valt terug op de aanmaaktijd van de taalversie. |
data.versions[].completedAt | Optionele voltooiingstijd in Unix-milliseconden. |
data.versions[].failedAt | Optionele fouttijd in Unix-milliseconden. |
data.versions[].timedOutAt | Optionele time-outtijd in Unix-milliseconden. |
data.versions[].translatedVideoUrl | Opgeslagen URL van de vertaalde video, of een lege string indien niet beschikbaar. |
data.versions[].translatedAudioUrl | Opgeslagen URL van de vertaalde audio, of een lege string indien niet beschikbaar. |
data.versions[].error | Optionele {code,message} wanneer de versie is mislukt. |
data.versions[].settings | Openbare versie-instellingen: voiceCloning, uploadType, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, subtitles, smartSync, dubbingMode, voiceIsolatorOption en optioneel translationQualityMode, cutBecauseFreeUser, originalDurationSeconds, cutDurationSeconds, voiceCloningSettings. |
data.versions[].settings.dubbingMode | translate of dub-only. SmartSync is false voor versies met dub-only. |
data.versions[].lipSync | Optionele {latest,history}; elk item bevat jobId, status, videoUrl, errorMessage, type, createdAt en optioneel requestedAt, retryRequestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled, isRetried. Lipsynchronisatietijden zijn opgeslagen als ISO-strings. |
data.versions[].dynamicSubtitles | Optioneel object met used, inProgress, magicZooms, magicBrolls, magicBrollsPercentage, videoUrl, errorMessage en optioneel removeSilencePace, removeBadTakes, templateName, requestedAt, rerunCount. requestedAt is in Unix-milliseconden. |
data.versions[].publicationAttempts | Optionele array met openbare publicatiepogingen: id, status, origin, plus optioneel scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
data.versions[].publishedVideos | Optionele array met type, videoId, privacyStatus en optioneel url, datePublished, origin, scheduledAt, plannedPublicationId. |
Er is al een taalversie voor de doeltaal in dit project.
Retourneert de volledige bestaande projectie van de taalversie; er wordt geen extra taalversie aangemaakt.HTTP 200
{
"data": {
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"projectId": "project_launch_2026",
"targetLanguage": "english",
"originalLanguage": "fr",
"createdAt": 1792152000000,
"isWorkWaitingForProofreading": true,
"pendingSegmentIndexes": [0, 1],
"versions": []
}
}
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.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":"translations_add"}'
HTTP 200
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_add",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"projectId": "project_launch_2026",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"targetLanguage": "english"
}
}
}
Opmerkingen bij de bewerking
- Het toevoegen van een nieuwe taal start geen transcriptie, vertaling of spraakgeneratie. De nieuwe taalversie wacht op proeflezen en begint met alle bronsegmentindexen in afwachting.
- Het pad voor een nieuwe taalversie retourneert exact projectId, workId en targetLanguage. Het pad voor een bestaande taalversie retourneert dezelfde projectie als translations_get.
- Start de daadwerkelijke mediaverwerking afzonderlijk met translations_start of translations_dub.
- Opgeslagen fouten geven VoiceCheap-foutcodes en vaste berichten terug. Gebruik de code en de huidige resourcestatus om te bepalen hoe u kunt herstellen.
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 | 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 | 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 | 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. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start. |
| 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. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["translations:write"]
}
}
Was deze pagina nuttig?

