Skip to main content
GET

Overview

Answers the caption lines of a project as they are on its timeline now, with each word and its timing. Use it to find what to correct, then send the fixes to Edit Project in captionSegments, by index.
  • index counts from 0 across the whole video. A project made from a template has one caption layer per scene; their lines are numbered one after the other.
  • startMs and endMs are milliseconds from the start of the video, for the line and for each word.
  • text is the line as stored. The caption style may show it in upper case.
  • disabled, preset and alignment are the captions’ current switch, style and position.
  • A project without captions answers hasCaptions: false and no segments. Captions cannot be added through the API.
A new caption style (caption.preset) re-cuts the lines to fit its box, so their number and indexes change. Read the captions again after changing the style.

Errors

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
string
required

The projectId a create endpoint answered, or one from GET /v1/project/list.

Response

The project's captions

success
boolean
message
string
data
object