Skip to main content
POST
Bereid tijdstempels per woord voor een spraakcreatie waarvan je eigenaar bent voor of haal ze op. Retourneert ready, processing of unavailable. Voltooide uitlijning wordt in de cache opgeslagen.

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
Geschiedenis-ID geretourneerd door tts_generate of tts_list.Patroon: ^(free-)?[0-9a-f]{64}$.
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. Uitlijningsstatus en woordtijdstempels voor de spraakaudio waarvan je eigenaar bent.

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.
  • status is ready met tijdstempels, processing terwijl een andere uitlijning actief is, of unavailable wanneer uitlijning momenteel niet kan worden geproduceerd. processing en unavailable retourneren wordAlignment: null.
  • Een bestaande geslaagde uitlijning wordt gecachet. Bij een appvoorbeeld wordt alleen het hoorbare deel van het script uitgelijnd; om het voorbeeld te voltooien, moet de nieuwe volledige audio worden uitgelijnd.
  • Brontekenindexen verwijzen naar spokenText nadat de ondersteunde tags voor de voordracht zijn verwijderd, zoals geretourneerd door tts_get.
  • Een voltooide actieaanvraag die processing retourneerde, behoudt dat vastgelegde resultaat bij idempotente herhaling. Gebruik tts_get om beschikbare tijdstempels te bekijken, of start een nieuwe uitlijningscontrole met een nieuwe requestId nadat de actieve uitlijning is voltooid.
  • 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