Skip to content

Export captions

GEThttps://api.vidmoat.com/v1/projects/{id}/captions
Bearer tokenScope projects.readFreeTry it in the playground

The project's captions as a subtitle file: SRT or WebVTT, one cue per caption clip in timeline seconds, UTF-8. Upload it beside the video, or hand it to a translator.

Path parameters#

  • idstringrequired
    The project id.

Query parameters#

  • formatstringdefault srt
    srt, vtt, or json for { projectId, cues: [{ start, end, lines }] }.

Response#

Returns 200 (application/x-subrip, text/vtt or application/json).

Response fields#

  • (body)text
    The file, application/x-subrip or text/vtt, as an attachment named after the project. X-Caption-Cues says how many cues it holds. With format=json, a JSON object instead (see format).

Errors#

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

StatusCodeWhen
404not_foundNo such project, or it is not yours. The two are indistinguishable on purpose.
400invalid_requestformat is not srt, vtt or json.