> ## 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. # Sprachausgabe generieren > 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. 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. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/tts_generate ``` ## Authentifizierung und Berechtigungen 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 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}$`. Textwert. Mindestlänge: 1. Höchstlänge: 128000. Eine Stimmauswahl-ID aus voices\_list, einschließlich clone:-IDs für gespeicherte benutzerdefinierte Stimmen. Mindestlänge: 1. Höchstlänge: 255. Textwert. Zulässige Werte: "text", "pdf". Standardwert: "text". Textwert. Zulässige Werte: "default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic". Standardwert: "default". Textwert. Höchstlänge: 300. Numerischer Wert. Minimum: 0.5. Maximum: 2. Standardwert: 1. 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. ```json theme={null} { "type": "object", "properties": { "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}$" }, "text": { "type": "string", "minLength": 1, "maxLength": 128000 }, "voice": { "type": "string", "minLength": 1, "maxLength": 255, "description": "A voice selection ID from voices_list, including clone: IDs for saved custom voices." }, "inputType": { "default": "text", "type": "string", "enum": ["text", "pdf"] }, "instructionPreset": { "default": "default", "type": "string", "enum": ["default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic"] }, "instructions": { "type": "string", "maxLength": 300 }, "speed": { "default": 1, "type": "number", "minimum": 0.5, "maximum": 2 }, "sourceFileName": { "type": "string", "maxLength": 255 } }, "required": ["text", "voice"], "additionalProperties": false } ``` ## 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. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_generate' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","text":"Hello world.","voice":"933563129e564b19a115bedd57b7406a","inputType":"text","instructionPreset":"narrator","instructions":"Speak clearly and leave a short pause at the end.","speed":1,"sourceFileName":"launch-script.txt"}' ``` ```javascript JavaScript theme={null} const input = { requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91', text: 'Hello world.', voice: '933563129e564b19a115bedd57b7406a', inputType: 'text', instructionPreset: 'narrator', instructions: 'Speak clearly and leave a short pause at the end.', speed: 1, sourceFileName: 'launch-script.txt', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_generate', { 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/tts_generate", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "text": "Hello world.", "voice": "933563129e564b19a115bedd57b7406a", "inputType": "text", "instructionPreset": "narrator", "instructions": "Speak clearly and leave a short pause at the end.", "speed": 1, "sourceFileName": "launch-script.txt"}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## 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. ```json HTTP 202 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "status": "running", "pollAction": "action_request_get", "pollAfterSeconds": 5 }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 200 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d", "status": "completed", "characterCount": 12, "previewEndIndex": null, "downloadUrl": "https://files.example.com/launch-script-speech.mp3" }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_generate", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_generate", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ## Ergebnisfelder | Feld | Beschreibung | | - | - | | `data.requestId` | Für die Generierungsaktion übergebene UUID v4. | | `data.historyId` | Eigene Sprachausgabeverlaufs-ID: 64 kleingeschriebene Hexadezimalzeichen, bei einer App-Vorschau optional mit dem Präfix free-. | | `data.status` | completed, wenn das Sprachausgabeergebnis bereit ist. | | `data.characterCount` | Anzahl der Zeichen im vollständigen Eingabetext nach dem Entfernen äußerer Leerzeichen. | | `data.previewEndIndex` | Zeichengrenze der teilweisen Audiovorschau oder null bei vollständigen Audiodaten. Die kostenpflichtige Generierung über die Integration gibt vollständige Audiodaten zurück. | | `data.downloadUrl` | Temporäre MP3-Download-URL. Fordern Sie über tts\_download eine neue an. | ## 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. ```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":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"tts_generate"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "tts_generate", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d", "status": "completed", "characterCount": 12, "previewEndIndex": null, "downloadUrl": "https://files.example.com/launch-script-speech.mp3" } } } ``` ## 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 | HTTP-Status | Code | Bedeutung oder Behebung | | - | - | - | | 400 | `CREDENTIAL_IN_QUERY` | Zugangsdaten wurden in einem Abfrageparameter namens access\_token oder api\_key übergeben. Senden Sie Zugangsdaten in Headern. | | 400 | `IDEMPOTENCY_CONFLICT` | Der Header Idempotency-Key und das Feld requestId im Anfragetext müssen übereinstimmen. | | 400 | `INVALID_REQUEST_ID` | Geben Sie eine UUID v4 als requestId oder Idempotency-Key an. | | 400 | `INVALID_VOICE` | Die Stimmauswahl ist ungültig, gehört nicht diesem Konto oder hat nicht den Status ready. | | 400 | `TEXT_REQUIRED` | Das Skript ist nach dem Entfernen der Tags zur Steuerung der Sprechweise leer. | | 400 | `TEXT_TOO_LONG` | Das Skript überschreitet die Zeichengrenze pro Generierung des aktuellen Tarifs. | | 400 | `VALIDATION_ERROR` | Die Eingabe entspricht nicht dem Aktionsschema; prüfen Sie details auf Feldfehler. | | 400 | `VOICE_UNAVAILABLE` | Die ausgewählte Katalogstimme ist nicht mehr verfügbar; wählen Sie eine von voices\_list zurückgegebene ID. | | 401 | `API_KEY_EXPIRED` | Der API-Schlüssel ist abgelaufen. | | 401 | `INVALID_API_KEY` | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. | | 401 | `INVALID_CREDENTIAL` | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. | | 401 | `MISSING_CREDENTIAL` | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. | | 401 | `USER_NOT_FOUND` | Das Konto des Zugangsnachweises existiert nicht mehr. | | 403 | `ACCOUNT_UNAVAILABLE` | Das ausführende Konto oder das Abrechnungskonto ist nicht verfügbar oder wird gerade gelöscht. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. | | 403 | `INSUFFICIENT_SCOPE` | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Die Integrationslimits des Kontos konnten nicht verifiziert werden. | | 403 | `PAID_PLAN_REQUIRED` | Das aktuelle Konto hat keinen kostenpflichtigen Tarif mehr für die Sprachgenerierung über die Integration. | | 403 | `SUBSCRIPTION_REQUIRED` | Verwenden Sie ein aktives kostenpflichtiges Abonnement. | | 403 | `TEAM_OWNER_NOT_FOUND` | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Für dieses Konto laufen bereits 10 Integrationsaktionen. Fragen Sie eine vorhandene Anfrage ab, bevor Sie eine weitere starten. | | 409 | `IDEMPOTENCY_CONFLICT` | Verwenden Sie eine Kennung nur mit derselben Operation und denselben Argumenten erneut. | | 409 | `TEXT_TO_SPEECH_GENERATION_IN_PROGRESS` | Eine identische Sprachanfrage wird noch verarbeitet. | | 409 | `TEXT_TO_SPEECH_REQUEST_CONFLICT` | Diese requestId wurde bereits mit einer anderen Spracheingabe verwendet. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. | | 429 | `TEXT_TO_SPEECH_CHARACTER_LIMIT_REACHED` | Das Skript überschreitet die insgesamt verfügbaren enthaltenen und gekauften TTS-Zeichen. | | 500 | `INTERNAL_ERROR` | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. | | 502 | `INTERNAL_ERROR` | Die Aktion konnte nicht abgeschlossen oder ihr Ergebnis nicht bestätigt werden. Prüfen Sie den Anfragestatus und den Ressourcenverlauf, bevor Sie eine weitere Generierung starten. | | 503 | `ACTION_RESULT_UNAVAILABLE` | Die Aktion wurde ausgeführt, ihr Ergebnis konnte jedoch nicht gespeichert werden. Prüfen Sie den gespeicherten Anfragestatus und den Ressourcenverlauf, bevor Sie eine neue Generierung starten. | | 503 | `SERVER_RESTARTING` | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["tts:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.