Generate Video from Proofread

cURL Example

curl --request POST \
  --url https://api.heygen.com/v3/video-translations/proofreads/{proofread_id}/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "captions": false,
  "translate_audio_only": false,
  "callback_id": "<string>",
  "callback_url": "<string>"
}'

Response Codes

  • 200
  • 400
  • 401
  • 404
  • 429

Response Example

{
  "data": {
    "video_translation_id": "<string>",
    "status": "processing"
  }
}

Authorizations

ApiKeyAuth

  • x-api-key: string (header, required) - HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

  • proofread_id: string (required) - Unique proofread identifier.

Request Body

Field Type Description
captions boolean Generate captions for the translated video (default: false)
translate_audio_only boolean Only translate audio, keep original video (default: false)
callback_id string  null ID included in webhook payload
callback_url string  null Webhook URL for completion notifications

Successful Response

200

{
  "data": {
    "video_translation_id": "<string>",
    "status": "processing"
  }
}

Documentation Index

Fetch the complete documentation index at: Documentation Index - Use this file to discover all available pages before exploring further.