Overview
Retrieve the complete details of a Video Agent using its unique Video Agent ID. This endpoint returns the agent configuration, including its avatar, voice, language, system prompt, greeting message, and associated Knowledge Bases.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.
Response
boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Human-readable success message.
object
Complete Video Agent configuration.
string
Unique identifier of the Video Agent.
string
Display name of the Video Agent.
string
Configured avatar gender.
string
Avatar assigned to the Video Agent.
string
Voice assigned to the Video Agent.
string
Primary language used by the Video Agent.
string
System prompt that defines the Video Agent’s behavior.
string
Greeting message spoken when a conversation starts.
array[string]
Knowledge Base IDs attached to the Video Agent.
string
Current status of the Video Agent.
string
Timestamp indicating when the Video Agent was created.
string
Timestamp indicating when the Video Agent was last updated.
Error Handling
The returned Video Agent ID can be used with:
PATCH /api/video-agent/{id}to update the Video Agent.DELETE /api/video-agent/{id}to permanently delete the Video Agent.