HEheygen
Videos

Edit Video

Changed on

Edits a video and renders it again under the same video_id. Send the edit_version from GET /v3/videos/{video_id}/scenes; a stale version returns 409. The render is charged as an API render. Idempotency-Key is required; if the key store is unavailable, a retry can render, and charge, a second time. Follow the render with GET /v3/videos/{video_id} or a webhook.

post/v3/videos/{video_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/videos/{video_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

video_idstring required

Unique video identifier

Headers

Idempotency-Keystring required

Required client-supplied key for safely retrying a request that charges. A retry within 24 hours that shares this key returns the original response instead of running again. The body must be the same: a different body under the same key returns 409 conflict. A retry that arrives while the original is still in flight gets a 409 request_in_progress. When the original could not be confirmed, repeating it with the same key settles that attempt instead of starting another. Scope is the space plus the request path, so the same key on another video is independent, and a key sent by another member of the space replays that member's response. A missing or blank value is rejected with 400. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default.

Request body

edit_versionstring required

The edit_version from the scenes read you are editing from. The edit is refused if the video changed since. The video refuses edits while it renders, and the render updates its document, so after the render finishes, read the scenes again for the next edit.

callback_urlstring

Webhook URL to receive a POST notification when the video is ready.

callback_idstring

Caller-defined identifier echoed back in the webhook payload.

Response

Successful response

errorobject nullable

Changes