HEheygen
Video Translate

Generate Video from Proofread

Changed on

Starts final video generation using the approved subtitles from a proofread session.

post/v3/video-translations/proofreads/{proofread_id}/generate

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/video-translations/proofreads/{proofread_id}/generate
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

proofread_idstring required

Unique proofread identifier

Headers

Idempotency-Keystring

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.

Request body

captionsboolean

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

translate_audio_onlyboolean

Only translate audio, keep original video

callback_idstring nullable

ID included in webhook payload

callback_urlstring nullable

Webhook URL for completion notifications

Response

Successful response

Changes

  • 7dfa5e59b4f5Revision changes
    • info

      request property deprecated

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status