Skip to main content
POST
Erstellen Sie Stimmenvorschläge anhand einer Beschreibung unter Verwendung Ihres Kontingents für Stimmentwürfe. Hören Sie diese mit voices_preview_get an und speichern Sie anschließend die gewünschte Vorschau.

Authentifizierung und Berechtigungen

string
erforderlich
Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt. OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
Erforderliche Berechtigungen: voices:write. Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

Parameter

string
An der Transportschnittstelle optional: Bei fehlender Angabe fügt der Server vor der Validierung eine Kennung ein. Geben Sie eine eigene stabile UUID v4 an, um eine verlorene Antwort sicher wiederherstellen zu können.Format: “uuid”. Muster: ^[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
erforderlich
Textwert.Mindestlänge: 1. Höchstlänge: 80.
string
erforderlich
Textwert.Mindestlänge: 1. Höchstlänge: 2000.
string
Textwert.Höchstlänge: 35. Muster: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.

Idempotenz

Verwenden Sie für jede Mutation eine UUID v4 in requestId oder im HTTP-Header Idempotency-Key. Verwenden Sie nach einem Netzwerkfehler dieselbe Kennung und identische Argumente erneut. Wenn Sie beides angeben, müssen die Werte übereinstimmen. Die Wiederholung einer gespeicherten Anfrage führt die Operation nicht erneut aus und verbraucht keinen weiteren monatlichen Aufruf. Fehlgeschlagene oder unterbrochene Anfragen werden nicht automatisch neu gestartet. Jede Mutation kann HTTP 202 zurückgeben, wenn bei einem Wiederholungsversuch dieselbe Anfrage noch läuft, auch wenn ihre erste Ausführung normalerweise synchron erfolgt. Wenn die Ausführung abgeschlossen ist, resultStored aber false ist, gibt ein Wiederholungsversuch HTTP 200 mit dem gespeicherten Anfragestatus anstelle des ursprünglichen Ergebnisses zurück. Rufen Sie die Ausgabe über die für ihren Bereich vorgesehene Verlaufs-, Ergebnis- oder Downloadaktion ab.

Anfragebeispiele

Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.

Antwort

Diese Operation gibt während der Ausführung HTTP 202 zurück. Speichern Sie requestId und fragen Sie action_request_get mit dieser Kennung und dem ursprünglichen Operationsnamen ab. Die Abfragestatus sind running, completed, failed und interrupted. Ein abgeschlossenes Ergebnis kann auf einen separaten Medienauftrag verweisen; verwenden Sie anschließend die für die Operation vorgesehene Status- oder Ausgabeaktion. Alle aktiven ungespeicherten Vorschauen und aktualisierten Erstellungskontingente, einschließlich zweier neuer entworfener Stimmkandidaten.

Ergebnisfelder

Diese Anfrage wiederherstellen und abfragen

Verwenden Sie auch nach einem Verbindungsabbruch dieselbe Kennung. Wenn resultStored den Wert false hat, rufen Sie die Ausgabe über die entsprechende Verlaufs-, Ergebnis- oder Downloadaktion ab. Starten Sie niemals eine zweite Generierung, nur um den Fortschritt zu prüfen.
HTTP 200

Hinweise zur Operation

  • Verwenden Sie für diese Mutation eine requestId im Format UUID v4 und bei Wiederholungsversuchen dieselbe ID mit identischen Argumenten erneut. Lang laufende Aktionen geben zunächst eine Anfrage mit dem Status running zurück; dieses Beispiel zeigt das abgeschlossene Handler-Ergebnis, das über action_request_get verfügbar ist.
  • name enthält nach dem Entfernen äußerer Leerzeichen 1–80 Zeichen. description enthält nach dem Entfernen äußerer Leerzeichen 1–2,000 Zeichen. Das optionale language akzeptiert einen Code mit 2–3 Buchstaben, optionalen Subtags und einer Höchstlänge von 35 Zeichen.
  • Eine erfolgreiche Designanfrage erstellt zwei Kandidaten mit kind: design und nummerierten Namen und verbraucht eine tägliche Designanfrage. Kostenpflichtige Tarife erlauben fünf Anfragen pro UTC-Tag; prüfen Sie creationUsage.design für die aktuelle Anzahl und den Zeitpunkt der Zurücksetzung.
  • Kandidaten sind 24 Stunden gültig und sind keine gespeicherten, wiederverwendbaren TTS-Stimmen. Hören Sie sie mit voices_preview_get an und speichern Sie anschließend einen ausgewählten Kandidaten mit voices_save_preview.
  • Die Antwort enthält frühere aktive Vorschauen sowie die neuen Kandidaten. Ein Platz für eine gespeicherte Stimme wird erst belegt, wenn ein Kandidat gespeichert wird.
  • Der Sprachausgabeverlauf und benutzerdefinierte Stimmen gehören dem authentifizierten Konto. Die Teamabrechnung gewährt keinen Zugriff auf die Sprachausgaben oder Stimmen anderer Mitglieder.

Nutzung

Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.

Fehler