HEheygen
Videos

Create Video

Changed on

Creates an avatar video: a HeyGen avatar or an image speaks your script or audio with lip-sync. Choose Avatar III, IV or V with engine (Avatar IV by default). To generate a whole scene from a prompt instead, use POST /v3/models/videos.

post/v3/videos

Request

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

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

OR
OR
OR

Response

Successful response

Example response

{
  "data": {
    "video_id": "v_abc123def456",
    "status": "waiting"
  }
}

Changes

  • 7dfa5e59b4f5Revision changes
    • breaking

      removed the enum value 4:5 of the request property /

    • breaking

      removed the enum value 5:4 of the request property /

    • breaking

      removed the enum value auto of the request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property ////

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property ////////

    • info

      added the new optional request property /////

    • info

      added the new optional request property //////

    • info

      added avatar cinematic_avatar image studio mapping keys to the request discriminator

    • info

      added asset_id base64 url discriminator mapping keys to the /// request property

    • info

      added asset_id base64 url discriminator mapping keys to the / request property

    • info

      added asset_id base64 url discriminator mapping keys to the /// request property

    • info

      added asset_id base64 url discriminator mapping keys to the /// request property

    • info

      added asset_id base64 url discriminator mapping keys to the //// request property

    • info

      added asset_id base64 url discriminator mapping keys to the //// request property

    • info

      added asset_id base64 url discriminator mapping keys to the /// request property

    • info

      added avatar_iii avatar_iv avatar_v discriminator mapping keys to the // request property

    • info

      added avatar_iii avatar_iv avatar_v discriminator mapping keys to the ////// request property

    • info

      added avatar_video image video discriminator mapping keys to the // request property

    • info

      added color image video discriminator mapping keys to the ////// request property

    • info

      added elevenlabs fish starfish discriminator mapping keys to the //// request property

    • info

      added elevenlabs fish starfish discriminator mapping keys to the //// request property

    • info

      added elevenlabs fish starfish discriminator mapping keys to the //////// request property

    • info

      added elevenlabs fish starfish discriminator mapping keys to the /////// request property

    • info

      added elevenlabs fish starfish discriminator mapping keys to the /////// request property

    • info

      added the new eleven_v4 enum value to the request property ///////

    • info

      added the new eleven_v4 enum value to the request property ///////

    • info

      added the new eleven_v4 enum value to the request property ///////////

    • info

      added the new eleven_v4 enum value to the request property //////////

    • info

      added the new eleven_v4 enum value to the request property //////////

    • info

      added the new s2.1-pro enum value to the request property ///////

    • info

      added the new s2.1-pro enum value to the request property ///////

    • info

      added the new s2.1-pro enum value to the request property ///////////

    • info

      added the new s2.1-pro enum value to the request property //////////

    • info

      added the new s2.1-pro enum value to the request property //////////

    • info

      added to the ////// request property oneOf list

    • 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