Skip to main content
POST
Utwórz propozycje głosów na podstawie opisu, korzystając z limitu projektowania głosów. Odsłuchaj je przez voices_preview_get, a następnie zapisz wybrany podgląd.

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.
Wymagane uprawnienia: 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
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}$.
string
wymagane
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 80.
string
wymagane
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 2000.
string
Wartość tekstowa.Maksymalna długość: 35. Wzorzec: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
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.

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.

Odpowiedź

Ta operacja zwraca HTTP 202 podczas przetwarzania. Zapisz requestId i odpytuj action_request_get, podając ten identyfikator oraz nazwę pierwotnej operacji. Stany odpytywania to running, completed, failed i interrupted. Zakończony wynik może wskazywać osobne zadanie przetwarzania multimediów; kontynuuj za pomocą akcji stanu lub wyniku właściwej dla tej operacji. Wszystkie aktywne niezapisane podglądy i zaktualizowane limity tworzenia, w tym dwa nowe projekty głosów do wyboru.

Pola wyniku

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.
HTTP 200

Uwagi do operacji

  • Użyj requestId w formacie UUID v4 dla tej mutacji i używaj go ponownie z identycznymi argumentami przy ponawianiu żądania. Długotrwałe akcje najpierw zwracają żądanie w stanie running; ten przykład przedstawia ukończony wynik procedury obsługi dostępny przez action_request_get.
  • name zawiera 1–80 znaków po usunięciu skrajnych białych znaków. description zawiera 1–2,000 znaków po usunięciu skrajnych białych znaków. Opcjonalne language przyjmuje kod złożony z 2–3 liter z opcjonalnymi podtagami i o maksymalnej długości 35 znaków.
  • Udane żądanie projektowania tworzy dwa głosy kandydujące z kind: design i numerowanymi nazwami oraz zużywa jedno dzienne żądanie projektowania. Płatne plany dopuszczają pięć żądań na dzień UTC; sprawdź creationUsage.design, aby poznać aktualną liczbę i czas resetu.
  • Kandydaci są dostępni przez 24 godziny i nie są zapisanymi głosami TTS do ponownego użycia. Odsłuchaj ich za pomocą voices_preview_get, a następnie zapisz wybranego kandydata za pomocą voices_save_preview.
  • Odpowiedź obejmuje wcześniejsze aktywne podglądy oraz nowych kandydatów. Miejsce na zapisany głos nie jest zajmowane, dopóki kandydat nie zostanie zapisany.
  • Historia mowy i głosy niestandardowe należą do uwierzytelnionego konta. Rozliczanie w ramach zespołu nie daje dostępu do mowy ani głosów innego członka.

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