Skip to main content
POST
Generate Video from Proofread

Authorizations

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}$

Path Parameters

proofread_id
string
required

Unique proofread identifier

Body

application/json

Request body for POST /v3/video-translations/proofreads/{id}/generate.

captions
boolean
default:false
deprecated

Deprecated and ignored: captions are always generated; whether to display them is a download-side choice.

translate_audio_only
boolean
default:false

Only translate audio, keep original video

callback_id
string | null

ID included in webhook payload

callback_url
string | null

Webhook URL for completion notifications

Response

Successful response

data
GenerateVideoResponse · object

Response for POST /v3/video-translations/proofreads/{id}/generate.