> ## 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. # Een stem ontwerpen > Maak stemkandidaten op basis van een beschrijving binnen je limiet voor stemontwerp. Beluister ze met voices_preview_get en sla daarna het gekozen voorbeeld op. Maak stemkandidaten op basis van een beschrijving binnen je limiet voor stemontwerp. Beluister ze met voices\_preview\_get en sla daarna het gekozen voorbeeld op. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/voices_design ``` ## 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: `voices: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: 80. Tekstwaarde. Minimale lengte: 1. Maximale lengte: 2000. Tekstwaarde. Maximale lengte: 35. Patroon: `^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$`. 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}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "description": { "type": "string", "minLength": 1, "maxLength": 2000 }, "language": { "type": "string", "maxLength": 35, "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$" } }, "required": ["name", "description"], "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/voices_design' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","description":"A warm, clear English narrator with steady pacing and a natural conversational delivery.","language":"en"}' ``` ```javascript JavaScript theme={null} const input = { requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91', name: 'Studio narrator', description: 'A warm, clear English narrator with steady pacing and a natural conversational delivery.', language: 'en', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_design', { 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/voices_design", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "description": "A warm, clear English narrator with steady pacing and a natural conversational delivery.", "language": "en"}, 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. Alle actieve niet-opgeslagen previews en bijgewerkte aanmaakquota, inclusief twee nieuwe kandidaten voor ontworpen stemmen. ```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": { "voicePreviews": [ { "id": "44444444-4444-4444-8444-444444444444", "kind": "design", "name": "Studio narrator 1", "previewUrl": "https://files.example.com/designed-narrator-1.wav", "expiresAt": 1792238400000, "durationSeconds": 8 }, { "id": "55555555-5555-4555-8555-555555555555", "kind": "design", "name": "Studio narrator 2", "previewUrl": "https://files.example.com/designed-narrator-2.wav", "expiresAt": 1792238400000, "durationSeconds": 9 } ], "creationUsage": { "cloneTrial": { "limit": 1, "used": 0, "remaining": 1 }, "design": { "limit": 5, "used": 1, "remaining": 4, "resetsAt": 1792195200000 }, "previewExpiresAfterHours": 24 } }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "voices_design", "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": "voices_design", "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.voicePreviews` | Alle momenteel actieve, niet-opgeslagen previews voor dit account, inclusief kandidaten uit eerdere aanvragen. | | `data.voicePreviews[].id` | UUID v4 van het voorbeeld, gebruikt door voices\_preview\_get en voices\_save\_preview. | | `data.voicePreviews[].kind` | clone of design. | | `data.voicePreviews[].name` | Weergavenaam van de preview; bij ontworpen kandidaten wordt een nummer aan de aangevraagde naam toegevoegd. | | `data.voicePreviews[].previewUrl` | Tijdelijke afspeelbare audio-URL. Vraag met voices\_preview\_get een nieuwe URL aan zolang het voorbeeld actief blijft. | | `data.voicePreviews[].expiresAt` | Vervaltijd van het voorbeeld als Unix-tijdstempel in milliseconden. | | `data.voicePreviews[].durationSeconds` | Duur van de preview-audio in seconden. | | `data.creationUsage.cloneTrial` | Proeflimiet voor kloonvoorbeelden gedurende de levensduur van het account, met limit, used en remaining. | | `data.creationUsage.design` | Dagelijks quotum voor stemontwerp met limit, used, remaining en resetsAt in Unix-milliseconden. | | `data.creationUsage.previewExpiresAfterHours` | Geldigheidsduur van een niet-opgeslagen voorbeeld in uren, momenteel 24. | ## 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":"voices_design"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "voices_design", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "voicePreviews": [ { "id": "44444444-4444-4444-8444-444444444444", "kind": "design", "name": "Studio narrator 1", "previewUrl": "https://files.example.com/designed-narrator-1.wav", "expiresAt": 1792238400000, "durationSeconds": 8 }, { "id": "55555555-5555-4555-8555-555555555555", "kind": "design", "name": "Studio narrator 2", "previewUrl": "https://files.example.com/designed-narrator-2.wav", "expiresAt": 1792238400000, "durationSeconds": 9 } ], "creationUsage": { "cloneTrial": { "limit": 1, "used": 0, "remaining": 1 }, "design": { "limit": 5, "used": 1, "remaining": 4, "resetsAt": 1792195200000 }, "previewExpiresAfterHours": 24 } } } } ``` ## 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. * name bevat 1–80 tekens na het verwijderen van witruimte aan het begin en einde. description bevat 1–2,000 tekens na het verwijderen van witruimte aan het begin en einde. Het optionele language accepteert een code van 2–3 letters met optionele subtags en maximaal 35 tekens. * Een geslaagde ontwerpaanvraag maakt twee kandidaten met kind: design en genummerde namen aan en verbruikt één dagelijkse ontwerpaanvraag. Betaalde abonnementen staan vijf aanvragen per UTC-dag toe; bekijk creationUsage.design voor het huidige aantal en het resettijdstip. * Kandidaten blijven 24 uur beschikbaar en zijn geen opgeslagen, herbruikbare TTS-stemmen. Beluister ze met voices\_preview\_get en sla vervolgens een geselecteerde kandidaat op met voices\_save\_preview. * Het antwoord bevat zowel eerdere actieve voorbeelden als de nieuwe kandidaten. Er wordt geen plaats voor opgeslagen stemmen bezet totdat een kandidaat wordt opgeslagen. * 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 | `VALIDATION_ERROR` | De invoer komt niet overeen met het actieschema; controleer details op veldfouten. | | 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 | `SUBSCRIPTION_REQUIRED` | Gebruik een actief betaald abonnement. | | 403 | `TEAM_OWNER_NOT_FOUND` | Het effectieve account van de teameigenaar kon niet worden gevonden. | | 404 | `USER_NOT_FOUND` | Het aangemelde account bestaat niet meer. | | 404 | `VOICE_PREVIEW_NOT_FOUND` | De aanvraag behoort toe aan een ander account. | | 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 | `VOICE_CREATION_IN_PROGRESS` | De preview wordt nog aangemaakt of accountverwijdering blokkeert nieuwe stembewerkingen. | | 409 | `VOICE_CREATION_REQUEST_MISMATCH` | Deze requestId is gebruikt voor een ander stemtype of andere instellingen of samples. | | 409 | `VOICE_DESIGN_LIMIT_REACHED` | Het dagelijkse tegoed voor stemontwerp is opgebruikt. | | 410 | `VOICE_PREVIEW_EXPIRED` | Het stemvoorbeeld van de aanvraag is verlopen of niet meer beschikbaar. | | 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. | | 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": ["voices:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.