Skip to main content
POST
Maak een project van je geüploade fileKey en transcribeer het. Duur en bestandsgrootte worden gecontroleerd aan de hand van de opgeslagen media. Een optionele webhookUrl ontvangt verwerkingsgebeurtenissen. Controleer projects_status.

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: projects:write, transcription: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: 1024.
string
vereist
Tekstwaarde.Toegestane waarden: “afrikaans”, “albanian”, “amharic”, “arabic”, “armenian”, “assamese”, “azerbaijani”, “basque”, “belarusian”, “bengali”, “bosnian”, “bulgarian”, “catalan”, “croatian”, “czech”, “danish”, “dutch”, “english”, “british english”, “estonian”, “finnish”, “french”, “french canadian”, “galician”, “german”, “greek”, “gujarati”, “hebrew”, “hindi”, “hungarian”, “icelandic”, “indonesian”, “irish”, “italian”, “japanese”, “kannada”, “kazakh”, “khmer”, “korean”, “lao”, “latvian”, “lithuanian”, “macedonian”, “malay”, “malayalam”, “mandarin”, “marathi”, “mongolian”, “nepali”, “norwegian”, “persian”, “polish”, “portuguese”, “brazilian portuguese”, “pt_brazil”, “punjabi”, “romanian”, “russian”, “serbian”, “slovak”, “slovenian”, “spanish”, “swahili”, “swedish”, “tagalog”, “tamil”, “telugu”, “thai”, “turkish”, “ukrainian”, “urdu”, “vietnamese”, “welsh”, “yoruba”, “zulu”.
string
Tekstwaarde.Toegestane waarden: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
string
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 200.
string
Tekstwaarde.Toegestane waarden: “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “16”, “17”, “18”, “19”, “20”, “21”, “22”, “23”, “24”, “25”, “26”, “27”, “28”, “29”, “30”, “31”, “32”, “auto-detect”.
array
Lijst met waarden. Zie het volledige invoerschema voor de structuur van de items.Maximaal aantal items: 1000.
boolean
Booleaanse waarde.
string
Tekstwaarde.Maximale lengte: 1000000.
string
Tekstwaarde.Maximale lengte: 2048. Formaat: “uri”.
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. Retourneert de nieuwe projectidentiteit direct na het starten van de transcriptie. Dit start geen vertaling en retourneert geen voltooid transcript.

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

  • Upload of importeer de media eerst en geef de voltooide fileKey door die bij de aangemelde uitvoerende gebruiker hoort. De duur, het MIME-type en de grootte in bytes worden gemeten aan de hand van dat opgeslagen object; dit zijn geen invoervelden die de aanroepende gebruiker bepaalt.
  • targetLanguage is vereist, hoewel deze actie alleen transcribeert. Gebruik translations_start of translations_dub nadat de oorspronkelijke transcriptie is voltooid.
  • sourceSrt vervangt de brontranscriptietekst en vereist een expliciete originalLanguage. brandVocabulary wordt gevalideerd en gebruikt anders de opgeslagen woordenschat van het account.
  • webhookUrl is een optionele vervanging voor de openbare HTTPS-callback. Privé- of onveilige netwerkbestemmingen worden geweigerd.
  • Vraag projects_status op en gebruik daarna transcripts_get voor het transcript; de status processing in dit resultaat beschrijft de mediaworkflow.
  • originalLanguage gebruikt brontaalcodes zoals fr of en (of auto-detect waar dit wordt geaccepteerd); targetLanguage gebruikt ondersteunde doeltaalnamen zoals english.

Verbruik

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

Fouten