Skip to main content
POST
Start een multipart-upload waarvan je eigenaar bent. Upload elk onderdeel naar de bijbehorende ondertekende URL en voltooi de upload voordat je een generatieactie aanroept.

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: voices:write. Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.

Parameters

string
vereist
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 255. Patroon: ^[^/\\\r\n\0]+$.
string
vereist
Tekstwaarde.Toegestane waarden: “audio/mpeg”, “audio/mp3”, “audio/wav”, “audio/x-wav”, “audio/mp4”, “audio/x-m4a”, “audio/ogg”, “audio/opus”, “audio/x-opus”.
integer
vereist
Gehele waarde.Maximum: 20971520.
string
Tekstwaarde.Vereiste waarde: “voice_sample”. Standaardwaarde: “voice_sample”.
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}$.
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

Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Een multipart-uploadsessie waarvan je eigenaar bent. key is een opslagreferentie; voltooi alle delen voordat je deze gebruikt als fileKey voor generatie.

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

  • Vereist een betaald abonnement en de actiemachtiging. Het persoonlijke toolabonnement van de uitvoerende gebruiker wordt bij uitvoering opnieuw gecontroleerd; opgeslagen tools en uploadreferenties behoren toe aan die gebruiker, ook wanneer het toegangsmiddel aan een team is gekoppeld.
  • Een geslaagde actie verbruikt één gedeelde maandelijkse API/MCP-aanroep. Beginner staat 500, Starter 5,000 en Creator 25,000 aanroepen/maand toe; Pro, Scale en Enterprise hebben geen maandelijkse bovengrens. De limieten per minuut blijven gelden: respectievelijk 30, 60, 120, 180, 300 en 600. Tegoeden voor toolgeneraties staan hier los van.
  • Gebruik een UUID v4 voor requestId of een identieke Idempotency-Key-header en behoud dezelfde actie, ID en argumenten bij nieuwe pogingen. Een herhaling uit de cache verbruikt geen extra maandelijkse aanroep.
  • Het uploadvoorvoegsel bepaalt het vereiste recht. tools gebruikt transcription:write, subtitles gebruikt subtitles:write, projects gebruikt projects:write en voices gebruikt voices:write.
  • Stemvoorbeelden ondersteunen alleen MP3-, WAV-, M4A-, OGG- of Opus-audio en zijn beperkt tot 20 MiB (20,971,520 bytes). Het MIME-type moet een van de gedocumenteerde audiotypen zijn. De standaardwaarde van kind is voice_sample; deze actiefamilie heeft geen upload_import-actie.
  • Gebruik de fileKey van het voltooide voorbeeldbestand met de bijbehorende actie om een stem aan te maken. Alleen uploaden maakt geen stem aan en genereert geen spraak.
  • De invoerbestandsnaam moet één bestandsnaam zijn, zonder slashes, backslashes, CR, LF of NUL. De contentType moet een ondersteund audio-/video-MIME-type zijn, of application/octet-stream voor andere uploads dan stemuploads.
  • Initialisatie retourneert key, geen fileKey. Bewaar uploadId afzonderlijk; dit is de UUID die wordt gebruikt voor ondertekening, voltooiing en afbreken.
  • partSize wordt gekozen van 5 MiB tot 100 MiB. Bereken het aantal delen als ceil(fileSize / partSize), gebruik maximaal maxConcurrency gelijktijdige PUTs en bewaar elke geretourneerde ETag.
  • Uploadsessies verlopen na 24 uur. Het voorbereiden van een upload telt niet mee voor de dagelijkse generatielimiet.

Verbruik

Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.

Fouten