Create video with Video Agent

Create a video from a text prompt using Video Agent. Returns a session resource with session_id for tracking and video_id for polling status via GET /v3/videos/. Files can be provided as asset_id (from POST /v3/assets), HTTPS URL, or base64-encoded content. Supported types: image (png, jpeg), video (mp4, webm), audio (mp3, wav), and pdf.

POST /v3/video-agents

Create video with Video Agent

cURL

curl --request POST \
  --url https://api.heygen.com/v3/video-agents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "<string>",
  "avatar_id": "<string>",
  "voice_id": "<string>",
  "style_id": "<string>",
  "orientation": "landscape",
  "files": [
    {
      "type": "<string>",
      "url": "<string>"
    }
  ],
  "callback_url": "<string>",
  "callback_id": "<string>",
  "incognito_mode": false
}
'

200

{}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Body

application/json

Request body for creating a video from a prompt using Video Agent v3.

All configuration is flat (no nested config object). Files use the type-discriminated AssetInput union for flexible asset inputs.

prompt · string · required

The message/prompt for video generation (1-10000 characters)

Required string length: 1 - 10000

avatar_id · string | null

Specific avatar ID to use

voice_id · string | null

Specific voice ID to use for narration

style_id · string | null

Style ID from GET /v3/video-agents/styles. Applies a curated visual template to the generated video.

orientation · enum<string> | null

Video orientation. If not provided, auto-detected from content.

Available options: landscape, portrait

files · (AssetUrl · object | AssetId · object | AssetBase64 · object)[] | null

Optional file attachments (max 20 files)

Maximum array length: 20

Asset input via publicly accessible HTTPS URL.

AssetUrl

AssetId

AssetBase64

Show child attributes

callback_url · string | null

Webhook URL for completion/failure notifications

callback_id · string | null

Optional callback ID included in webhook payload

incognito_mode · boolean · default: false

When enabled, disables memory injection and extraction for this session

Response

200

application/json

Successful response

data · CreateVideoAgentResponse · object

Response from creating a video agent session.

Designed as a session resource for future extensibility — GET /v3/video-agents/{session_id} can return the same shape enriched with more fields (messages, video URL, etc.).

Show child attributes