Skip to main content
POST
/
v3
/
video-agents
/
sessions
Create interactive Video Agent session
curl --request POST \
  --url https://api.heygen.com/v3/video-agents/sessions \
  --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>"
    }
  ],
  "auto_proceed": false,
  "callback_url": "<string>",
  "callback_id": "<string>",
  "incognito_mode": false
}
'
{}

Authorizations

​
x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Body

application/json

Request body for creating an interactive Video Agent session.

​
prompt
string
required

Initial message to the Video Agent (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.

​
auto_proceed
boolean
default:false

If true, skip interactive review and go straight to video generation (no storyboard approval step)

​
callback_url
string | null

Persisted for future webhook delivery — not active in v1

​
callback_id
string | null

Persisted alongside callback_url for future use

​
incognito_mode
boolean
default:false

When enabled, disables memory injection and extraction for this session

Response

Successful response

​
data
CreateSessionResponse · object

Response from creating an interactive video agent session.