Get video translation caption

Get the caption file (SRT or VTT format) for a completed video translation. Requires enable_caption=true when creating the translation.

GET /v3/video-translations/{video_translation_id}/caption

Get video translation caption

cURL

curl --request GET \
  --url https://api.heygen.com/v3/video-translations/{video_translation_id}/caption \
  --header 'x-api-key: <api-key>'

200

{}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

video_translation_id · string · required

Unique video translation identifier

Query Parameters

format · enum<string> · required

Caption format: 'srt' or 'vtt'

Available options: vtt, srt

Response

200

application/json

Successful response

data · VideoTranslationCaptionResponse · object

Response for GET /v3/video-translations/{id}/caption.

Show child attributes