Skip to main content
POST
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.

Authenticatie en machtigingen

string
vereist
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

string
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}$.
string
vereist
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 128000.
string
vereist
Een stemselectie-ID uit voices_list, inclusief clone:-ID’s voor opgeslagen aangepaste stemmen.Minimale lengte: 1. Maximale lengte: 255.
string
Tekstwaarde.Toegestane waarden: “text”, “pdf”. Standaardwaarde: “text”.
string
Tekstwaarde.Toegestane waarden: “default”, “cheerful”, “calm”, “narrator”, “dramatic”, “whisper”, “energetic”. Standaardwaarde: “default”.
string
Tekstwaarde.Maximale lengte: 300.
number
Numerieke waarde.Minimum: 0.5. Maximum: 2. Standaardwaarde: 1.
string
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.

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.

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.

Resultaatvelden

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.
HTTP 200

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