> ## 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. # Spraak genereren > Maak spraak van tekst met een stem uit de catalogus of een aangepaste stem waarvan je eigenaar bent. Gebruikt hetzelfde tekentegoed en dezelfde abonnementslimieten als de app. Retourneert een geschiedenis-ID en een tijdelijke audio-download-URL. Gebruik requestId opnieuw om een tweede generatie te voorkomen. Maak spraak van tekst met een stem uit de catalogus of een aangepaste stem waarvan je eigenaar bent. Gebruikt hetzelfde tekentegoed en dezelfde abonnementslimieten als de app. Retourneert een geschiedenis-ID en een tijdelijke audio-download-URL. Gebruik requestId opnieuw om een tweede generatie te voorkomen. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/tts_generate ``` ## Authenticatie en machtigingen Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens worden alleen door MCP geaccepteerd, niet door dit REST-endpoint. Vereiste machtigingen: `tts:write`. Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten. ## Parameters Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat. Formaat: "uuid". Patroon: `^[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}$`. Tekstwaarde. Minimale lengte: 1. Maximale lengte: 128000. Een stemselectie-ID uit voices\_list, inclusief clone:-ID's voor opgeslagen aangepaste stemmen. Minimale lengte: 1. Maximale lengte: 255. Tekstwaarde. Toegestane waarden: "text", "pdf". Standaardwaarde: "text". Tekstwaarde. Toegestane waarden: "default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic". Standaardwaarde: "default". Tekstwaarde. Maximale lengte: 300. Numerieke waarde. Minimum: 0.5. Maximum: 2. Standaardwaarde: 1. Tekstwaarde. Maximale lengte: 255. Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking. ```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 } ``` ## Idempotentie Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart. Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein. ## Voorbeeldaanvragen Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert. ```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) ``` ## Antwoord Deze bewerking retourneert HTTP 202 zolang deze wordt uitgevoerd. Bewaar requestId en controleer action\_request\_get met die identificatie en de oorspronkelijke bewerkingsnaam. De mogelijke statussen zijn running, completed, failed en interrupted. Een voltooid resultaat kan naar een afzonderlijke mediataak verwijzen; ga dan verder met de status- of uitvoeractie van die bewerking. Metadata van de voltooide spraakgeneratie en een tijdelijke MP3-download-URL. De handler retourneert geen audiobytes. ```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" } ``` ## Resultaatvelden | Veld | Beschrijving | | - | - | | `data.requestId` | UUID v4 die voor de generatieactie is opgegeven. | | `data.historyId` | ID uit de spraakgeschiedenis die je bezit: 64 hexadecimale tekens in kleine letters, optioneel voorafgegaan door free- voor een app-voorbeeld. | | `data.status` | completed wanneer het spraakresultaat gereed is. | | `data.characterCount` | Aantal tekens in de volledige invoertekst na het verwijderen van witruimte aan het begin en einde. | | `data.previewEndIndex` | Tekengrens van gedeeltelijke preview-audio, of null voor volledige audio. Betaalde generatie via de integratie retourneert volledige audio. | | `data.downloadUrl` | Tijdelijke MP3-download-URL. Vraag een nieuwe aan via tts\_download. | ## Deze aanvraag herstellen en controleren Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren. ```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" } } } ``` ## Opmerkingen bij de bewerking * Gebruik een UUID v4 requestId voor deze mutatie en hergebruik deze met identieke argumenten bij nieuwe pogingen. Langdurige acties retourneren eerst een aanvraag met status running; dit voorbeeld is het voltooide handlerresultaat dat beschikbaar is via action\_request\_get. * Kies voice uit voices\_list. Stem-ID's voor nasynchronisatie uit dubbing\_voices\_list vormen een afzonderlijke bibliotheek. * Witruimte aan het begin en einde van de tekst wordt verwijderd. Het schema accepteert maximaal 128,000 tekens; de huidige Beginner- en Starter-abonnementen staan 64,000 per generatie toe, terwijl Creator en hogere abonnementen 128,000 toestaan. Het huidige abonnement en het beschikbare TTS-tekentegoed worden vóór de generatie opnieuw gecontroleerd. * inputType is standaard text en kan text of pdf zijn. Geef ook bij pdf geëxtraheerde tekst op in text; deze actie accepteert geen PDF-upload of -URL. * instructionPreset is standaard default en ondersteunt default, cheerful, calm, narrator, dramatic, whisper en energetic. instructions is optioneel en beperkt tot 300 tekens na het verwijderen van witruimte aan het begin en einde. speed is standaard 1 en loopt van 0.5 tot 2. * sourceFileName is optionele metadata, beperkt tot 255 tekens na het verwijderen van witruimte aan het begin en einde, en bepaalt de downloadbestandsnaam. * Een geslaagde herhaalde aanvraag speelt opgeslagen audio opnieuw af zonder deze opnieuw te genereren of in rekening te brengen. URL's zijn tijdelijk; gebruik tts\_download voor een nieuwe download. * Spraakgeschiedenis en aangepaste stemmen behoren toe aan het aangemelde account. Facturering via een team geeft geen toegang tot de spraak of stemmen van een ander lid. ## Verbruik Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing. ## Fouten | HTTP-status | Code | Betekenis of herstel | | - | - | - | | 400 | `CREDENTIAL_IN_QUERY` | Inloggegevens zijn opgegeven in een queryparameter access\_token of api\_key. Stuur inloggegevens in headers. | | 400 | `IDEMPOTENCY_CONFLICT` | De header Idempotency-Key en het bodyveld requestId moeten overeenkomen. | | 400 | `INVALID_REQUEST_ID` | Geef een UUID v4 op als requestId of Idempotency-Key. | | 400 | `INVALID_VOICE` | De stemselectie is ongeldig, is niet van dit account of is niet gereed. | | 400 | `TEXT_REQUIRED` | Het script is leeg na het verwijderen van de tags voor spraaksturing. | | 400 | `TEXT_TOO_LONG` | Het script overschrijdt de tekenlimiet per generatie van het huidige abonnement. | | 400 | `VALIDATION_ERROR` | De invoer komt niet overeen met het actieschema; controleer details op veldfouten. | | 400 | `VOICE_UNAVAILABLE` | De geselecteerde catalogusstem is niet meer beschikbaar; kies een ID die door voices\_list is geretourneerd. | | 401 | `API_KEY_EXPIRED` | De API-sleutel is verlopen. | | 401 | `INVALID_API_KEY` | Geef een geldige, niet-verlopen API-sleutel op. | | 401 | `INVALID_CREDENTIAL` | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. | | 401 | `MISSING_CREDENTIAL` | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. | | 401 | `USER_NOT_FOUND` | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. | | 403 | `ACCOUNT_UNAVAILABLE` | Het uitvoerende of factureringsaccount is niet beschikbaar of wordt verwijderd. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. | | 403 | `INSUFFICIENT_SCOPE` | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | De integratielimieten van het account konden niet worden geverifieerd. | | 403 | `PAID_PLAN_REQUIRED` | Het huidige account heeft geen betaald abonnement meer voor spraakgeneratie via de integratie. | | 403 | `SUBSCRIPTION_REQUIRED` | Gebruik een actief betaald abonnement. | | 403 | `TEAM_OWNER_NOT_FOUND` | Het effectieve account van de teameigenaar kon niet worden gevonden. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start. | | 409 | `IDEMPOTENCY_CONFLICT` | Gebruik een identificatie alleen opnieuw met dezelfde bewerking en argumenten. | | 409 | `TEXT_TO_SPEECH_GENERATION_IN_PROGRESS` | Een identieke spraakaanvraag wordt nog verwerkt. | | 409 | `TEXT_TO_SPEECH_REQUEST_CONFLICT` | Deze requestId is al gebruikt met andere spraakinvoer. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wacht tot de maandelijkse reset of wijzig je abonnement. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. | | 429 | `TEXT_TO_SPEECH_CHARACTER_LIMIT_REACHED` | Het script overschrijdt het totaal aan beschikbare inbegrepen en gekochte TTS-tekens. | | 500 | `INTERNAL_ERROR` | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. | | 502 | `INTERNAL_ERROR` | De actie kon niet worden voltooid of het resultaat kon niet worden bevestigd. Controleer de aanvraagstatus en de resourcegeschiedenis voordat je een nieuwe generatie start. | | 503 | `ACTION_RESULT_UNAVAILABLE` | De actie is uitgevoerd, maar het resultaat kon niet worden opgeslagen. Controleer de opgeslagen aanvraagstatus en resourcegeschiedenis voordat je een nieuwe generatie start. | | 503 | `SERVER_RESTARTING` | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. | ```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.