HEheygen
Custom Agents

Edit Custom Agent Video

Changed on

Edits a completed custom-agent video from a natural-language instruction, reusing the source run's composition and paid media. Returns a NEW video_id; poll GET /v3/custom-agents/videos/{video_id} for status and the MP4 URL.

post/v3/custom-agents/videos/{video_id}/edits

Request

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

Path parameters

video_idstring required

Source video id to edit.

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

user_inputstring required

What to change about the source video.

Response

Accepted — submission acknowledged; poll for completion.

Changes