Overview
Update the configuration of an existing Video Agent. You can modify its name, avatar, voice, language, prompts, and associated Knowledge Bases without recreating the agent.Prerequisites
- Bearer Token authentication
- Valid Video Agent ID
Request
string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the Video Agent.
Request Body
string
Updated display name of the Video Agent.
string
Avatar assigned to the Video Agent.
string
Voice to be used during conversations.
string
Primary language spoken by the Video Agent.
string
System prompt that controls the Video Agent’s behavior.
string
Greeting message spoken at the beginning of a conversation.
array[string]
List of Knowledge Base IDs associated with the Video Agent.
Response
boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Confirmation message indicating the Video Agent was updated successfully.
object
Updated Video Agent information.
string
Unique identifier of the Video Agent.
string
Updated display name.
string
Updated avatar.
string
Updated voice.
string
Updated language.
string
Current status of the Video Agent.
string
Timestamp indicating when the Video Agent was last updated.
Error Handling
Only the fields included in the request body are updated. Any omitted fields retain their existing values.
After updating the Video Agent, you can retrieve the latest configuration using:
GET /api/video-agent/{id}