Transcribe media

POSThttps://api.vidmoat.com/v1/ai/transcriptions

Bearer tokenScope ai.transcribe10 cr / 5 minTry it in the playground

Word-level timings for captions. Feed words[] straight into an addCaptions command.

Body#

srcstring
A public http(s) URL, or one of your upload URLs or filenames. Required unless you send script.
languagestring
Language code, for example en.
scriptstring
Free mode: text to spread evenly over duration. No provider is called.
durationnumber
Free mode: seconds to spread script over.
startnumberdefault 0
Free mode: offset of the first word.

Response#

Returns 200.

Response fields#

wordsarray
{ text, start, end } per word, in seconds.
providerstring
Which engine answered (script in free mode).
mediaSecondsnumber
The measured length that was billed.
creditsobject
{ charged, remaining, basis }.

Errors#

Besides the errors any request can get (authentication, rate limits):

Status	Code	When
400	`invalid_request`	Neither `src` nor `script` + `duration`; a refused URL; unreadable media; or media longer than 30 minutes (`mediaSeconds`, `maxSeconds`).
402	`insufficient_credits`	The balance cannot cover the call. Nothing ran. `remaining` is the balance.
501	`not_configured`	No speech-to-text provider is available. Nothing is charged.
502	`provider_error`	The generation provider failed. The charge is refunded.

curl

curl -X POST https://api.vidmoat.com/v1/ai/transcriptions \
  -H "Authorization: Bearer $VIDMOAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"src":"https://example.com/voice.mp3","language":"en"}'

Response 200

{
  "words": [{ "text": "Hello", "start": 0, "end": 0.4 }],
  "provider": "whisper",
  "mediaSeconds": 42.5,
  "credits": { "charged": 10, "remaining": 4490, "basis": "10 credits per 5 minutes of media, rounded up" }
}