curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"filename":"voice-sample.wav","contentType":"audio/wav","fileSize":1048576,"kind":"voice_sample","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
filename: 'voice-sample.wav',
contentType: 'audio/wav',
fileSize: 1048576,
kind: 'voice_sample',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_initialize', {
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/voices_upload_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"filename": "voice-sample.wav", "contentType": "audio/wav", "fileSize": 1048576, "kind": "voice_sample", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
"key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
Głosy do syntezy mowy
Rozpocznij przesyłanie multimediów (próbki głosu)
Rozpocznij należące do Ciebie przesyłanie wieloczęściowe. Prześlij każdą część pod jej podpisany adres URL, a następnie zakończ przesyłanie przed wywołaniem akcji generowania.
POST
/
v1
/
actions
/
voices_upload_initialize
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"filename":"voice-sample.wav","contentType":"audio/wav","fileSize":1048576,"kind":"voice_sample","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
filename: 'voice-sample.wav',
contentType: 'audio/wav',
fileSize: 1048576,
kind: 'voice_sample',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_initialize', {
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/voices_upload_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"filename": "voice-sample.wav", "contentType": "audio/wav", "fileSize": 1048576, "kind": "voice_sample", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
"key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
Rozpocznij należące do Ciebie przesyłanie wieloczęściowe. Prześlij każdą część pod jej podpisany adres URL, a następnie zakończ przesyłanie przed wywołaniem akcji generowania.
Wymagane uprawnienia:
POST https://api.voicecheap.ai/v1/actions/voices_upload_initialize
Uwierzytelnianie i uprawnienia
string
wymagane
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.
voices: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
string
wymagane
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 255. Wzorzec:
^[^/\\\r\n\0]+$.string
wymagane
Wartość tekstowa.Dozwolone wartości: “audio/mpeg”, “audio/mp3”, “audio/wav”, “audio/x-wav”, “audio/mp4”, “audio/x-m4a”, “audio/ogg”, “audio/opus”, “audio/x-opus”.
integer
wymagane
Liczba całkowita.Maksimum: 20971520.
string
Wartość tekstowa.Wymagana wartość: “voice_sample”. Wartość domyślna: “voice_sample”.
string
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}$.Pełny schemat danych wejściowych
Pełny schemat danych wejściowych
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.
{
"type": "object",
"properties": {
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[^/\\\\\\r\\n\\0]+$"
},
"contentType": {
"type": "string",
"enum": ["audio/mpeg", "audio/mp3", "audio/wav", "audio/x-wav", "audio/mp4", "audio/x-m4a", "audio/ogg", "audio/opus", "audio/x-opus"]
},
"fileSize": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 20971520
},
"kind": {
"default": "voice_sample",
"type": "string",
"const": "voice_sample"
},
"requestId": {
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
"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}$"
}
},
"required": ["filename", "contentType", "fileSize"],
"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.curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_initialize' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"filename":"voice-sample.wav","contentType":"audio/wav","fileSize":1048576,"kind":"voice_sample","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
filename: 'voice-sample.wav',
contentType: 'audio/wav',
fileSize: 1048576,
kind: 'voice_sample',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_initialize', {
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/voices_upload_initialize",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"filename": "voice-sample.wav", "contentType": "audio/wav", "fileSize": 1048576, "kind": "voice_sample", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
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. Sesja przesyłania wieloczęściowego należąca do użytkownika. key jest odwołaniem do magazynu danych; ukończ wszystkie części przed użyciem go jako fileKey do generowania.{
"data": {
"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
"key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"partSize": 5242880,
"maxConcurrency": 4
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_initialize",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
Pola wyniku
| Pole | Opis |
|---|---|
data.uploadId | Nieprzezroczysty UUID aktywnej sesji przesyłania; używaj go bez zmian w kolejnych akcjach przesyłania wieloczęściowego. |
data.key | Klucz w magazynie należący do użytkownika wykonującego żądanie. Generowanie musi poczekać na upload_complete. |
data.partSize | Rozmiar w bajtach każdej części poza ostatnią. |
data.maxConcurrency | Zalecana maksymalna liczba jednocześnie przesyłanych części. |
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.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":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"voices_upload_initialize"}'
HTTP 200
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_initialize",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
"key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"partSize": 5242880,
"maxConcurrency": 4
}
}
}
Uwagi do operacji
- Wymaga płatnej subskrypcji i uprawnienia do akcji. Osobisty plan narzędzi użytkownika wykonującego żądanie jest ponownie sprawdzany podczas wykonywania; zapisane narzędzia i referencje przesłanych plików należą do tego użytkownika, również gdy dane uwierzytelniające są powiązane z zespołem.
- Pomyślna akcja zużywa jedno wspólne miesięczne wywołanie API/MCP. Beginner pozwala na 500, Starter na 5,000, a Creator na 25,000 wywołań miesięcznie; Pro, Scale i Enterprise nie mają miesięcznego limitu. Nadal obowiązują limity na minutę: odpowiednio 30, 60, 120, 180, 300 i 600. Limity generowania narzędzi są odrębne.
- Użyj requestId w formacie UUID v4 lub identycznego nagłówka Idempotency-Key i przy ponawianiu zachowuj tę samą akcję, identyfikator i argumenty. Odtworzenie zapisanej odpowiedzi nie zużywa kolejnego miesięcznego wywołania.
- Prefiks przesyłania określa wymagane uprawnienie. tools używa transcription:write, subtitles używa subtitles:write, projects używa projects:write, a voices używa voices:write.
- Próbki głosu obsługują wyłącznie audio MP3, WAV, M4A, OGG lub Opus i są ograniczone do 20 MiB (20,971,520 bajtów). Typ MIME musi być jednym z udokumentowanych typów audio. Domyślna wartość kind to voice_sample; ta rodzina nie ma akcji upload_import.
- Użyj fileKey ukończonej próbki w odpowiedniej akcji tworzenia głosu. Samo przesłanie pliku nie tworzy głosu ani nie generuje mowy.
- Wejściowa nazwa pliku musi być pojedynczą nazwą pliku, bez ukośników, ukośników odwrotnych, CR, LF ani NUL. contentType musi być obsługiwanym typem MIME audio lub wideo albo application/octet-stream dla przesyłania innego niż głosowe.
- Inicjalizacja zwraca key, a nie fileKey. Zachowaj uploadId osobno; to UUID używany do podpisywania, ukończenia i przerwania.
- partSize jest wybierane z zakresu od 5 MiB do 100 MiB. Oblicz liczbę części jako ceil(fileSize / partSize), używaj najwyżej maxConcurrency równoczesnych żądań PUT i zachowaj każdy zwrócony ETag.
- Sesje przesyłania wygasają po 24 godzinach. Przygotowanie przesyłania nie zużywa dziennego limitu generowania.
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 | BAD_REQUEST | Zadeklarowane fileSize przekracza limit przesyłania dla wybranego rodzaju lub planu. |
| 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 | IDEMPOTENCY_CONFLICT | Identyfikatory żądania w nagłówku i treści różnią się. |
| 400 | INVALID_REQUEST_ID | requestId lub Idempotency-Key nie jest identyfikatorem UUID v4. |
| 400 | VALIDATION_ERROR | Argumenty nie spełniają schematu akcji lub podano nieznany argument. |
| 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 | INSUFFICIENT_SCOPE | Klucz API lub połączenie MCP nie ma uprawnienia wymaganego do wykonania tej akcji. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Nie udało się zweryfikować limitów integracji konta. |
| 403 | PAID_SUBSCRIPTION_REQUIRED | Uwierzytelniony wywołujący nie ma już płatnej subskrypcji w chwili wykonywania tej akcji narzędzia. |
| 403 | SUBSCRIPTION_REQUIRED | Użyj aktywnej płatnej subskrypcji. |
| 403 | TEAM_OWNER_NOT_FOUND | Nie znaleziono konta faktycznego właściciela zespołu. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Na tym koncie działa już 10 akcji integracji. Sprawdzaj stan istniejącego żądania przed rozpoczęciem kolejnego. |
| 409 | IDEMPOTENCY_CONFLICT | Używaj ponownie identyfikatora wyłącznie z tą samą operacją i tymi samymi argumentami. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Wykorzystane i oczekujące wywołania osiągnęły wspólny miesięczny limit API/MCP. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Konto osiągnęło limit integracji na minutę; sprawdź retryAfterSeconds. |
| 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ę potwierdzić trwałego zapisania wyniku żądania. Sprawdzaj stan tej samej akcji i requestId oraz historię zasobu, zanim rozpoczniesz kolejny zapis. |
| 503 | INTERNAL_ERROR | Inicjalizacja przesyłania lub trwały zapis sesji są niedostępne. |
| 503 | SERVER_RESTARTING | Serwer jest uruchamiany ponownie. Spróbuj ponownie wkrótce i zachowaj ten sam identyfikator żądania dla operacji zmieniającej dane. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
Czy ta strona była pomocna?

