HEheygen
Video Agent

Send Video Agent Message

Changed on

Sends a follow-up turn to a session created in either generate or chat mode; follow-up turns preserve the session mode. Send a message, a scene edit_plan built from GET /v3/videos/{video_id}/scenes, or both. Items may reference different scene snapshots from this session; none identifies the output draft. edit_version is not a document lock, so two edits from one version may both be accepted. Returns the current working draft in video_id. Poll GET /v3/videos/{video_id} for status. For a failed video, inspect failure_code and failure_message; the session endpoint also exposes known stop reasons in error.

post/v3/video-agents/{session_id}

Request

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

Path parameters

session_idstring required

Session ID

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

Response

Successful response

Changes

  • 7dfa5e59b4f5Revision changes
    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the request body anyOf list

    • info

      the request property became optional

    • info

      the request property default value was added

    • info

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

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      added the non-success 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