Sign in

v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB
Video Agent

Create Video Agent Session

One-shot video generation from a prompt — agent handles scripting, avatar selection, scene composition, and rendering. Supports generate (fire-and-forget) and chat (multi-turn) modes.

post/v3/video-agents

Request body

promptstring required

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

mode'generate' | 'chat'
avatar_idstring nullable

Specific avatar ID to use

voice_idstring nullable

Specific voice ID to use for narration

style_idstring nullable

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

brand_kit_idstring nullable

Brand kit ID to apply brand colors, fonts, and logos to the generated video.

orientation'landscape' | 'portrait' nullable

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

callback_urlstring nullable

Webhook URL for completion/failure notifications

callback_idstring nullable

Optional callback ID included in webhook payload

incognito_modeboolean

When enabled, disables memory injection and extraction for this session

Response

Successful response

Example response

{
  "data": {
    "session_id": "sess_012abc345def678",
    "status": "generating",
    "video_id": "v_abc123def456",
    "created_at": 1711929600
  }
}