Skip to main content
POST
Erstellen Sie Sprachausgabe aus Text mit einer Katalogstimme oder einer eigenen Stimme Ihres Kontos. Es gelten dasselbe Zeichenguthaben und dieselben Tariflimits wie in der App. Gibt eine Verlaufs-ID und eine temporäre Audio-Download-URL zurück. Verwenden Sie requestId erneut, um eine zweite Generierung zu vermeiden.

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: tts: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: 128000.
string
erforderlich
Eine Stimmauswahl-ID aus voices_list, einschließlich clone:-IDs für gespeicherte benutzerdefinierte Stimmen.Mindestlänge: 1. Höchstlänge: 255.
string
Textwert.Zulässige Werte: “text”, “pdf”. Standardwert: “text”.
string
Textwert.Zulässige Werte: “default”, “cheerful”, “calm”, “narrator”, “dramatic”, “whisper”, “energetic”. Standardwert: “default”.
string
Textwert.Höchstlänge: 300.
number
Numerischer Wert.Minimum: 0.5. Maximum: 2. Standardwert: 1.
string
Textwert.Höchstlänge: 255.
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. Metadaten der abgeschlossenen Sprachausgabegenerierung und eine temporäre MP3-Download-URL. Der Handler gibt keine Audiobytes zurück.

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.
  • Wählen Sie voice aus voices_list. IDs von Synchronstimmen aus dubbing_voices_list gehören zu einer separaten Bibliothek.
  • Leerraum am Anfang und Ende des Texts wird entfernt. Das Schema akzeptiert höchstens 128,000 Zeichen; die aktuellen Tarife Beginner und Starter erlauben 64,000 pro Generierung, Creator und höhere Tarife dagegen 128,000. Der aktuelle Tarif und das verfügbare TTS-Zeichenguthaben werden vor der Generierung erneut geprüft.
  • inputType hat den Standardwert text und kann text oder pdf sein. Geben Sie auch bei pdf den extrahierten Text in text an; diese Aktion akzeptiert weder einen PDF-Upload noch eine URL.
  • instructionPreset hat den Standardwert default und unterstützt default, cheerful, calm, narrator, dramatic, whisper und energetic. instructions ist optional und nach dem Entfernen führender und nachgestellter Leerzeichen auf 300 Zeichen begrenzt. speed hat den Standardwert 1 und liegt zwischen 0.5 und 2.
  • sourceFileName ist ein optionales Metadatenfeld, nach dem Entfernen führender und nachfolgender Leerzeichen auf 255 Zeichen begrenzt und bestimmt den Download-Dateinamen.
  • Eine erfolgreiche wiederholte Anfrage gibt gespeichertes Audio erneut zurück, ohne es erneut zu generieren oder dafür erneut Gebühren zu berechnen. URLs sind temporär; verwenden Sie tts_download für einen neuen Download.
  • 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