> ## 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. # Ondertitelwoorden met tijdstempels maken > Transcribeer een geüploade audiotrack naar woorden met tijdstempels om ondertitels te bewerken. Het renderen van geanimeerde video’s en lokale bewerkingssessies in de browser zijn niet beschikbaar via deze bewerking. Retourneert een compacte verwijzing naar het opgeslagen resultaat; gebruik de bijbehorende getAction of downloadAction om de volledige uitvoer op te halen. Transcribeer een geüploade audiotrack naar woorden met tijdstempels om ondertitels te bewerken. Het renderen van geanimeerde video’s en lokale bewerkingssessies in de browser zijn niet beschikbaar via deze bewerking. Retourneert een compacte verwijzing naar het opgeslagen resultaat; gebruik de bijbehorende getAction of downloadAction om de volledige uitvoer op te halen. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/captions_transcribe ``` ## 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: `subtitles:write`. Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten. ## Parameters Een fileKey die je bezit, geretourneerd door een voltooide upload of media-import. Elke generatie verbruikt de bijbehorende geüploade bron. Minimale lengte: 1. Maximale lengte: 1024. Tekstwaarde. Minimale lengte: 1. Maximale lengte: 255. Patroon: `^[^/\\\r\n\0]+$`. Lijst met waarden. Zie het volledige invoerschema voor de structuur van de items. Maximaal aantal items: 100. 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. ```json theme={null} { "type": "object", "properties": { "fileKey": { "type": "string", "minLength": 1, "maxLength": 1024, "description": "An owned fileKey returned by a completed upload or media import. Each generation consumes its uploaded source." }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^/\\\\\\r\\n\\0]+$" }, "keyterms": { "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 } }, "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}$" } }, "required": ["fileKey"], "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/captions_transcribe' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"fileKey":"uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav","fileName":"interview.wav","keyterms":["VoiceCheap"],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}' ``` ```javascript JavaScript theme={null} const input = { fileKey: 'uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav', fileName: 'interview.wav', keyterms: ['VoiceCheap'], requestId: '13579bdf-2468-4ace-8bdf-0123456789ab', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/captions_transcribe', { 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/captions_transcribe", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.wav", "fileName": "interview.wav", "keyterms": ["VoiceCheap"], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"}, 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. Een opgeslagen verwijzing naar ondertitelwoorden. De volledige JSON bevat words, durationSeconds en optioneel detectedLanguage. Elk woord heeft text, startMs, endMs en een speakerId die null mag zijn. ```json HTTP 202 theme={null} { "data": { "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab", "status": "running", "pollAction": "action_request_get", "pollAfterSeconds": 5 }, "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab" } ``` ```json HTTP 200 theme={null} { "data": { "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b", "operation": "captions_transcribe", "createdAt": 1792152000000, "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json", "byteLength": 190, "contentType": "application/json; charset=utf-8", "status": "completed", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab", "getAction": "subtitles_result_get", "downloadAction": "subtitles_result_download", "listAction": "subtitles_result_list" }, "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab", "operation": "captions_transcribe", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab", "operation": "captions_transcribe", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab" } ``` ## Resultaatvelden | Veld | Beschrijving | | - | - | | `data.resultId` | UUID van opgeslagen uitvoer waarvan je eigenaar bent. Gebruik deze met getAction of downloadAction; deze verschilt van requestId en elke historyId. | | `data.operation` | Generatieactie die deze opgeslagen JSON heeft geproduceerd. | | `data.createdAt` | Unix-tijdstempel in milliseconden waarop de opgeslagen uitvoer is voorbereid. | | `data.fileName` | Voorgestelde bestandsnaam voor een JSON-export. | | `data.byteLength` | UTF-8-bytes van de volledige geserialiseerde uitvoer, niet van de compacte metadata. | | `data.contentType` | application/json; charset=utf-8. | | `data.status` | completed bij geslaagde generatie. De resultaatgeschiedenis kan ook herstelvermeldingen met de status pending tonen. | | `data.requestId` | UUID van de oorspronkelijke actieaanvraag, indien vastgelegd. | | `data.getAction` | Ophaalactie voor gegevens die je bezit; includeContent is standaard false en moet true zijn voor de volledige gestructureerde uitvoer. | | `data.downloadAction` | Geauthenticeerde exportactie die de volledige JSON als inhoudstekenreeks retourneert. | | `data.listAction` | Actie voor het weergeven van eigen opgeslagen uitvoer binnen dit machtigingsdomein. | ## 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":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"captions_transcribe"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab", "operation": "captions_transcribe", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b", "operation": "captions_transcribe", "createdAt": 1792152000000, "fileName": "voicecheap-captions_transcribe-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json", "byteLength": 190, "contentType": "application/json; charset=utf-8", "status": "completed", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab", "getAction": "subtitles_result_get", "downloadAction": "subtitles_result_download", "listAction": "subtitles_result_list" } } } ``` ## 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. * Dit is een asynchrone actie. Het eerste transportresultaat is een aanvraag met status running en pollAction; peil action\_request\_get met deze bewerking en de oorspronkelijke requestId. Het hier getoonde resultaat van de voltooide bewerking is een compacte referentie naar opgeslagen uitvoer, niet de gegenereerde body. * De volledige uitvoer wordt onder geauthenticeerd eigenaarschap opgeslagen in versleutelde opslag, onafhankelijk van de begrensde cache voor actiepolling. Roep de geretourneerde getAction aan met resultId en includeContent: true voor gestructureerde JSON, of downloadAction met resultId voor JSON-tekst. listAction biedt een herstelmogelijkheid als alleen de oorspronkelijke aanvraag bekend is. * De opgeslagen JSON is beperkt tot 32 MiB. Metadata onthult nooit de versleutelingssleutel voor de opslag of een transcriptiedownload-URL zonder authenticatie. * Een geslaagde generatie verbruikt één eenheid persoonlijk tooltegoed. Bij een mislukte generatie wordt de toolreservering normaal vrijgegeven. Als het onzeker is of de uitvoer is opgeslagen, controleer dan dezelfde aanvraag en de geschiedenis van opgeslagen resultaten voordat je opnieuw genereert; de server behoudt de reservering om dubbel verbruik te voorkomen. * Hogere abonnementen zonder maandelijkse integratiebovengrens hebben nog steeds de onderstaande dagelijkse tooltegoeden en medialimieten. Deze zelfstandige acties gebruiken hun tooltegoed in plaats van nasynchronisatieminuten of TTS-tekens. * Gebruik fileKey uit een voltooide upload of import waarvan je eigenaar bent en beschouw deze als eenmalig te gebruiken. Zodra de mediaverwerking begint, verwijdert de opschoning de bron na succes of een verwerkingsfout. Een afwijzing bij validatie of op basis van limieten vóór de verwerking kan de bron intact laten. Gebruik de oorspronkelijke requestId opnieuw om de geaccepteerde generatie te herstellen voordat je een nieuwe start. * Upload alleen het geëxtraheerde audiospoor: WAV, MP3, M4A, AAC, OGG, Opus of FLAC, maximaal 250 MiB. Een bestand met een videostream wordt geweigerd, ook als de bestandsnaam een audio-extensie heeft. * Beginner accepteert maximaal 30 minuten; Starter, Creator, Pro, Scale en Enterprise accepteren maximaal 60 minuten, plus een containertolerantie van 2 seconden. * Daglimiet voor transcriptie van ondertitels: Beginner 10, Starter 15, Creator 30, Pro 60, Scale 100 en Enterprise 100; gedeeld met de webtool voor ondertitels. * Woordoffsets worden uitgedrukt in milliseconden; durationSeconds in seconden. De server retourneert woorden met tijdsaanduidingen, geen gerenderde geanimeerde video. Het lokaal bewerken en renderen van ondertitels in de browser valt buiten deze actie. * Ondertiteltranscriptie heeft geen afzonderlijke actiegroep voor webgeschiedenis. Gebruik subtitles\_result\_list/get/download om de volledige integratie-uitvoer te herstellen. ## 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 | `DURATION_TOO_LONG` | De media overschrijden de maximale duur voor deze bewerking. | | 400 | `DURATION_UNKNOWN` | De uitvoeringsstap kon geen positieve mediaduur bepalen. | | 400 | `FILE_TOO_LARGE` | De opgeslagen bron overschrijdt de byteslimiet voor deze bewerking. | | 400 | `IDEMPOTENCY_CONFLICT` | De aanvraag-ID's in de header en de body verschillen. | | 400 | `INVALID_FILE_TYPE` | De bestandsextensie wordt niet ondersteund voor deze bewerking. | | 400 | `INVALID_MEDIA_DURATION` | De gemeten bronduur ontbreekt, is ongeldig of overschrijdt de maximale duur van het abonnement. | | 400 | `INVALID_MEDIA_STREAM` | De bron heeft geen bruikbare audiostream voor transcriptie. | | 400 | `INVALID_REQUEST_ID` | requestId of Idempotency-Key is geen UUID v4. | | 400 | `VALIDATION_ERROR` | De argumenten voldoen niet aan het actieschema of er is een onbekend argument opgegeven. | | 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` | De API-sleutel of MCP-verbinding heeft niet de vereiste actiemachtiging. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | De integratielimieten van het account konden niet worden geverifieerd. | | 403 | `INVALID_FILE_REFERENCE` | fileKey is geen geldige voltooide uploadreferentie die aan de actor toebehoort. | | 403 | `PAID_SUBSCRIPTION_REQUIRED` | De geauthenticeerde uitvoerende gebruiker heeft geen betaald abonnement meer wanneer deze toolactie wordt uitgevoerd. | | 403 | `SUBSCRIPTION_REQUIRED` | Gebruik een actief betaald abonnement. | | 403 | `TEAM_OWNER_NOT_FOUND` | Het effectieve account van de teameigenaar kon niet worden gevonden. | | 404 | `MEDIA_NOT_FOUND` | De voltooide bronupload ontbreekt of is leeg; een eerdere generatie kan deze hebben verbruikt. | | 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. | | 410 | `TOOL_RESULT_ACCOUNT_UNAVAILABLE` | Het account van de uitvoerende gebruiker wordt verwijderd of bestaat niet meer, waardoor er geen duurzaam resultaat kan worden opgeslagen. | | 413 | `TOOL_RESULT_TOO_LARGE` | De volledige gegenereerde JSON overschrijdt 32 MiB en kan niet als integratieresultaat worden opgeslagen. | | 422 | `TRANSCRIPTION_EMPTY` | De audio bevat geen herkende gesproken woorden. | | 429 | `ANIMATED_CAPTIONS_TOOL_DAILY_LIMIT_REACHED` | De uitvoerende gebruiker heeft het transcriptiequotum voor geanimeerde ondertitels opgebruikt. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Gebruikte en nog lopende aanroepen hebben het gedeelde maandelijkse API/MCP-quotum bereikt. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Het account heeft de integratielimiet per minuut bereikt; controleer retryAfterSeconds. | | 500 | `INTERNAL_ERROR` | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. | | 502 | `INTERNAL_ERROR` | Generatie of het opslaan van de uitvoer is mislukt. Controleer de oorspronkelijke aanvraag en de geschiedenis van opgeslagen resultaten voordat je een nieuwe generatie start. | | 503 | `ACTION_RESULT_UNAVAILABLE` | De actie is uitgevoerd, maar het opslaan van het aanvraagresultaat kon niet worden bevestigd. Vraag dezelfde actie en requestId op en controleer de resourcegeschiedenis voordat je een nieuwe schrijfactie start. | | 503 | `INTERNAL_ERROR` | De uitkomst van de generatie of het opslaan van het resultaat is onzeker of tijdelijk niet beschikbaar; gebruik geauthenticeerd resultaatherstel voordat je opnieuw genereert. | | 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": ["subtitles:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.