> ## 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.
# Przetłumacz istniejący projekt
> Przetłumacz projekt z wykonaną transkrypcją i utwórz dubbing w innym języku, ze zwykłą kontrolą kredytów, głosów i równoczesnych zadań. Sprawdzaj stan przez projects_status.
Przetłumacz projekt z wykonaną transkrypcją i utwórz dubbing w innym języku, ze zwykłą kontrolą kredytów, głosów i równoczesnych zadań. Sprawdzaj stan przez projects\_status.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/translations_start
```
## Uwierzytelnianie i uprawnienia
Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są
akceptowane tylko przez MCP, a nie przez ten endpoint REST.
Wymagane uprawnienia: `translations:write`.
Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu.
## Parametry
Wartość tekstowa.
Minimalna długość: 1. Maksymalna długość: 200. Wzorzec: `^[^/\\]+$`.
Wartość logiczna.
Wartość logiczna.
Wartość liczbowa.
Minimum: 1. Maksimum: 70.
Wartość tekstowa.
Dozwolone wartości: "cloning", "custom".
Wartość tekstowa.
Minimalna długość: 1. Maksymalna długość: 128.
Wartość logiczna.
Wartość tekstowa.
Dozwolone wartości: "translated", "original".
Wartość tekstowa.
Dozwolone wartości: "studio", "realistic".
Wartość tekstowa.
Dozwolone wartości: "standard", "pro", "studio".
Wartość logiczna.
Obiekt JSON. Pola zagnieżdżone opisuje pełny schemat danych wejściowych.
Lista wartości. Strukturę elementów opisuje pełny schemat danych wejściowych.
Maksymalna liczba elementów: 100.
Wartość tekstowa.
Dozwolone wartości: "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".
Opcjonalne na poziomie transportu: jeśli identyfikator zostanie pominięty, serwer doda go przed walidacją. Podaj własny, stały UUID v4, aby bezpiecznie odzyskać wynik po utracie odpowiedzi.
Format: "uuid". Wzorzec: `^[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}$`.
Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji.
```json theme={null}
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"keepBackgroundMusic": {
"type": "boolean"
},
"keepOriginalVoice": {
"type": "boolean"
},
"originalVoiceVolume": {
"type": "number",
"minimum": 1,
"maximum": 70
},
"voiceMode": {
"type": "string",
"enum": ["cloning", "custom"]
},
"voiceId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"subtitles": {
"type": "boolean"
},
"subtitlesSource": {
"type": "string",
"enum": ["translated", "original"]
},
"voiceIsolatorOption": {
"type": "string",
"enum": ["studio", "realistic"]
},
"lipSyncMode": {
"type": "string",
"enum": ["standard", "pro", "studio"]
},
"activeSpeakerDetectionEnabled": {
"type": "boolean"
},
"voiceCloningSettings": {
"type": "object",
"properties": {
"stability": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"similarity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": ["stability", "similarity"],
"additionalProperties": false
},
"translationTimeSkips": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"startTime": {
"type": "number",
"minimum": 0
},
"endTime": {
"type": "number",
"exclusiveMinimum": 0
}
},
"required": ["startTime", "endTime"],
"additionalProperties": false
}
},
"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
}
```
## Idempotencja
Dla każdej operacji zmieniającej dane użyj UUID v4 w requestId lub w nagłówku HTTP Idempotency-Key. Po awarii sieci użyj ponownie tego samego identyfikatora i identycznych argumentów. Jeśli podasz oba, muszą być zgodne. Ponowienie zapisanego żądania nie powtarza operacji ani nie zużywa kolejnego wywołania z miesięcznego limitu. Żądania zakończone błędem lub przerwane nie są automatycznie uruchamiane ponownie.
Każda operacja zmieniająca dane może zwrócić HTTP 202, gdy ponowienie napotka to samo żądanie nadal w stanie running, nawet jeśli jej pierwsze wykonanie zwykle jest synchroniczne. Jeśli wykonanie się zakończyło, ale resultStored ma wartość false, ponowienie zwraca HTTP 200 z zapisanym stanem żądania zamiast pierwotnego wyniku. Pobierz wynik za pomocą akcji historii, wyniku lub pobierania właściwej dla danej domeny.
## Przykłady żądań
Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_start' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","targetLanguage":"english","voiceMode":"cloning","keepBackgroundMusic":true,"requestId":"41321bda-e243-4b6f-96a4-622cd047c991"}'
```
```javascript JavaScript theme={null}
const input = {
projectId: 'project_launch_2026',
targetLanguage: 'english',
voiceMode: 'cloning',
keepBackgroundMusic: true,
requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_start', {
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/translations_start",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "targetLanguage": "english", "voiceMode": "cloning", "keepBackgroundMusic": True, "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)
```
## Odpowiedź
Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól.
Zwraca identyfikatory projektu i wersji języka docelowego po przyjęciu do realizacji tłumaczenia i dubbingu istniejącego projektu z transkrypcją.
```json HTTP 200 theme={null}
{
"data": {
"success": true,
"message": "Translation started successfully. Use the status endpoint to track progress.",
"projectId": "project_launch_2026",
"estimatedDuration": 10,
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_start",
"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": "translations_start",
"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"
}
```
## Pola wyniku
| Pole | Opis |
| - | - |
| `data.success` | Wartość true oznacza, że proces w tle został przyjęty do realizacji; nie oznacza gotowych multimediów. |
| `data.message` | Potwierdzenie tłumaczenia lub dubbingu na podstawie dostarczonego tłumaczenia. |
| `data.projectId` | Identyfikator projektu nadrzędnego. |
| `data.estimatedDuration` | Przybliżony szacowany czas przetwarzania w minutach: ceil(source duration in seconds / 60) \* 5. |
| `data.workId` | Identyfikator istniejącej lub nowo utworzonej wersji języka docelowego. |
## Odzyskaj żądanie i sprawdź jego stan
Używaj tego samego identyfikatora także po utracie połączenia. Jeśli resultStored ma wartość false, pobierz wynik za pomocą odpowiedniej akcji historii, wyniku lub pobierania. Nigdy nie uruchamiaj drugiego generowania tylko po to, aby sprawdzić postęp.
```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":"translations_start"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "translations_start",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"success": true,
"message": "Translation started successfully. Use the status endpoint to track progress.",
"projectId": "project_launch_2026",
"estimatedDuration": 10,
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"
}
}
}
```
## Uwagi do operacji
* Wymaga ukończonej, niepustej oryginalnej transkrypcji. Zapisany projekt dostarcza czas trwania i typ multimediów.
* Ponownie używa istniejącej wersji językowej, jeśli jest dostępna, a w przeciwnym razie ją tworzy. Równoczesne generowanie dubbingu w tym języku musi się zakończyć przed rozpoczęciem kolejnego.
* Ta akcja nie przyjmuje sourceSrt, translatedSrt, fileKey, adresu URL multimediów ani webhookUrl.
* Domyślna wartość voiceMode to cloning. Przy voiceMode custom użyj głosu z katalogu lub głosu niestandardowego zapisanego przez uwierzytelnione konto; nie podawaj voiceCloningSettings. Rozliczanie zespołowe nie daje dostępu do głosów zapisanych przez innych członków.
* Opcjonalne subtitles, lipSyncMode i translationTimeSkips wymagają wejścia wideo. Pomijane zakresy muszą mieścić się w czasie trwania multimediów, keepBackgroundMusic musi mieć wartość true, a keepOriginalVoice — false.
* lipSyncMode akceptuje standard, pro lub studio, zależnie od planu i standardowej weryfikacji kredytów na multimedia. Mowa i synchronizacja ruchu ust nie stają się bezpłatne z powodu nieograniczonej liczby miesięcznych wywołań API.
* Sprawdzaj projects\_status, aby śledzić przetwarzanie multimediów; pobierz wszystkie wersje językowe za pomocą projects\_get.
## Wykorzystanie
Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji.
## Błędy
| Status HTTP | Kod | Znaczenie lub sposób rozwiązania |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Dane uwierzytelniające zostały podane w parametrze zapytania access\_token lub api\_key. Wysyłaj dane uwierzytelniające w nagłówkach. |
| 400 | `DURATION_DETECTION_FAILED` | Zapisany czas trwania multimediów projektu jest niedostępny. |
| 400 | `IDEMPOTENCY_CONFLICT` | Nagłówek Idempotency-Key i pole requestId w treści żądania muszą być zgodne. |
| 400 | `INVALID_REQUEST_ID` | Podaj requestId lub Idempotency-Key w formacie UUID v4. |
| 400 | `LIPSYNC_NOT_AVAILABLE_FOR_AUDIO` | Synchronizacja ruchu ust wymaga wejściowego wideo. |
| 400 | `LIPSYNC_VIDEO_TOO_LONG` | Film przekracza limit czasu trwania dla wybranego trybu synchronizacji ruchu ust. |
| 400 | `SUBTITLES_NOT_AVAILABLE_FOR_AUDIO` | Napisy wtopione w obraz wymagają wejściowego wideo. |
| 400 | `TRANSLATION_TIME_SKIP_CONFLICT` | Pomijania przedziałów czasu w tłumaczeniu nie można łączyć z keepOriginalVoice o wartości true. |
| 400 | `TRANSLATION_TIME_SKIP_NOT_AVAILABLE_FOR_AUDIO` | Pomijanie przedziałów czasu w tłumaczeniu wymaga wejściowego wideo. |
| 400 | `TRANSLATION_TIME_SKIP_OUT_OF_RANGE` | Pomijany zakres wykracza poza czas trwania multimediów. |
| 400 | `TRANSLATION_TIME_SKIP_REQUIRES_BACKGROUND` | Pomijanie przedziałów czasu w tłumaczeniu wymaga keepBackgroundMusic o wartości true. |
| 400 | `VALIDATION_ERROR` | Popraw dane wejściowe zgodnie ze schematem. Nieprawidłowe lub niespójne wartości są odrzucane przed wykonaniem. |
| 400 | `VOICE_CLONING_SETTINGS_NOT_ALLOWED` | voiceCloningSettings mają zastosowanie wyłącznie do voiceMode cloning. |
| 400 | `VOICE_ID_NOT_ALLOWED_WITH_CLONING` | Nie można łączyć voiceId z voiceMode cloning. |
| 400 | `VOICE_ID_REQUIRED` | voiceMode o wartości custom wymaga voiceId. |
| 401 | `API_KEY_EXPIRED` | Klucz API wygasł. |
| 401 | `INVALID_API_KEY` | Podaj prawidłowy, niewygasły klucz API. |
| 401 | `INVALID_CREDENTIAL` | Nagłówek Authorization ma nieprawidłowy format lub jest sprzeczny z x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Nie podano użytecznych danych uwierzytelniających w nagłówku lub przekroczyły one 4096 znaków. |
| 401 | `USER_NOT_FOUND` | Konto powiązane z poświadczeniem już nie istnieje. |
| 403 | `ACCOUNT_UNAVAILABLE` | Konto wykonujące operację lub konto rozliczeniowe jest niedostępne albo jest w trakcie usuwania. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | Użytkownik, do którego należą dane uwierzytelniające, należy do więcej niż jednego zespołu, więc kontekst rozliczeniowy jest niejednoznaczny. |
| 403 | `CUSTOM_VOICE_ACCESS_DENIED` | Wybrany głos nie pochodzi z katalogu ani nie jest głosem niestandardowym zapisanym przez uwierzytelnione konto. |
| 403 | `FORBIDDEN` | Uwierzytelniony podmiot wykonujący akcję nie ma dostępu do tego projektu. |
| 403 | `INSUFFICIENT_CREDITS` | Konto nie ma wystarczającej liczby kredytów na multimedia dla wybranych ustawień mowy i opcjonalnej synchronizacji ruchu ust. |
| 403 | `INSUFFICIENT_SCOPE` | Nadaj wszystkie wymagane uprawnienia lub wybierz inne dane uwierzytelniające. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Nie udało się zweryfikować limitów integracji konta. |
| 403 | `LIPSYNC_MODE_ACCESS_DENIED` | Wybrany opcjonalny tryb synchronizacji ruchu ust jest niedostępny w bieżącym planie. |
| 403 | `SUBSCRIPTION_REQUIRED` | Użyj aktywnej płatnej subskrypcji. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Nie znaleziono konta faktycznego właściciela zespołu. |
| 404 | `PROJECT_NOT_FOUND` | Projekt nie istnieje na dostępnym koncie. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Na tym koncie działa już 10 akcji integracji. Sprawdzaj stan istniejącego żądania przed rozpoczęciem kolejnego. |
| 409 | `DUB_ONLY_REQUIRES_TRANSCRIPTION` | Przed rozpoczęciem tej akcji poczekaj na ukończoną, niepustą oryginalną transkrypcję. |
| 409 | `IDEMPOTENCY_CONFLICT` | Używaj ponownie identyfikatora wyłącznie z tą samą operacją i tymi samymi argumentami. |
| 409 | `TRANSLATION_ALREADY_IN_PROGRESS` | Trwa już generowanie dubbingu dla tego języka docelowego. |
| 429 | `CONCURRENT_TRANSLATION_LIMIT_REACHED` | Konto osiągnęło limit równoczesnych tłumaczeń. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Poczekaj na odnowienie miesięcznego limitu lub zmień plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Jeśli występuje nagłówek Retry-After, odczekaj wskazany czas i stosuj rosnące odstępy między ponowieniami. |
| 500 | `INTERNAL_ERROR` | Sprawdź stan zapisanego żądania i historię zasobu przed podjęciem decyzji o ponowieniu operacji zmieniającej dane. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | Akcja została wykonana, ale nie udało się zapisać jej wyniku. Sprawdź zapisany stan żądania i historię zasobu przed rozpoczęciem nowego generowania. |
| 503 | `SERVER_RESTARTING` | Serwer jest uruchamiany ponownie. Spróbuj ponownie wkrótce i zachowaj ten sam identyfikator żądania dla operacji zmieniającej dane. |
```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.