Create Proofread Session

Creates a proofread session that extracts editable subtitles from a video before final rendering.

POST /v3/video-translations/proofreads

Create Proofread Session

cURL

curl --request POST \
  --url https://api.heygen.com/v3/video-translations/proofreads \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "video": {
    "type": "<string>",
    "url": "<string>"
  },
  "output_languages": [
    "<string>"
  ],
  "title": "<string>",
  "brand_voice_id": "<string>",
  "brand_glossary_id": "<string>",
  "speaker_num": 123,
  "folder_id": "<string>",
  "enable_video_stretching": false,
  "disable_music_track": false,
  "enable_speech_enhancement": false,
  "srt": {
    "type": "<string>",
    "url": "<string>"
  },
  "mode": "speed",
  "keep_the_same_format": false
}
'

200

{
  "data": {
    "proofread_ids": [
      "<string>"
    ]
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Headers

Idempotency-Key · string

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9_\-:.]{1,255}$

Body

application/json

Request body for POST /v3/video-translations/proofreads.

video · AssetUrl · object · required

Asset input via publicly accessible HTTPS URL.

AssetUrl

AssetId

Show child attributes

output_languages · string[] · required

Target language codes. Use one for single proofread, multiple for batch.

Minimum array length: 1

title · string · required

Title for the proofread job

brand_voice_id · string | null

Brand glossary ID for custom term translations. Legacy field name for brand_glossary_id — both are accepted and resolve to the same workspace record. Discover IDs via GET /v3/brand-glossaries.

brand_glossary_id · string | null

Brand glossary ID for custom term translations (e.g. translate 'Reformer' as 'Pilates equipment', not 'political activist'). Alias for the legacy brand_voice_id field. Discover IDs via GET /v3/brand-glossaries.

speaker_num · integer | null

Number of speakers (improves speaker separation)

folder_id · string | null

Project/folder ID to organize proofread into

enable_video_stretching · boolean · default: false

Allow dynamic duration adjustment

disable_music_track · boolean · default: false

Remove background music

enable_speech_enhancement · boolean · default: false

Enhance speech quality

srt · AssetUrl · object

Asset input via publicly accessible HTTPS URL.

AssetUrl

AssetId

Show child attributes

mode · enum<string> · default: speed

Translation quality mode: 'speed' (faster) or 'precision' (higher quality)

Available options: speed, precision

keep_the_same_format · boolean · default: false

Preserve the source video's encoding specs (resolution, bitrate)

Response

200

application/json

Successful response

data · CreateProofreadResponse · object

Response for POST /v3/video-translations/proofreads.

Show child attributes