Skip to main content

Overview

Create a new Video Agent that can interact with users using an AI-generated avatar, voice, and knowledge base. Configure the agent’s behavior, appearance, and conversation settings during creation.

Prerequisites

  • Bearer Token authentication
  • Workspace access with permission to create Video Agents

Request

string
required
Bearer token for authenticated workspace access.

Request Body

string
required
Unique name for the Video Agent.
string
required
Gender of the AI avatar.
string
Avatar that represents the Video Agent.
string
Voice assigned to the Video Agent.
string
Primary language spoken by the Video Agent.
string
Instructions that define the Video Agent’s behavior.
string
Greeting spoken when the conversation begins.
array[string]
Knowledge Base IDs attached to the Video Agent.

Response

boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Success message returned by the API.
object
Details of the newly created Video Agent.
string
Unique identifier of the Video Agent.
string
Name of the Video Agent.
string
Configured avatar gender.
string
Selected avatar for the Video Agent.
string
Voice assigned to the Video Agent.
string
Primary language configured for the Video Agent.
string
Current status of the Video Agent.
string
Timestamp when the Video Agent was created.

Error Handling

After creating a Video Agent, you can:
  • Retrieve it using GET /api/video-agent/{id}
  • Update it using PATCH /api/video-agent/{id}
  • Attach Knowledge Bases
  • Configure supported voices using the Voices endpoint