Skip to main content

Overview

Retrieve a paginated list of all Video Agents in your workspace. This endpoint returns the video agent configuration along with search and pagination support, making it easy to manage large numbers of agents.

Prerequisites

  • Bearer Token authentication

Request

string
required
Bearer token for authenticated workspace access.
integer
Page number to retrieve. Default is 1.
integer
Number of Video Agents returned per page.
Search Video Agents by name.

Response

boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Success message returned by the API.
array
List of Video Agents available in the authenticated workspace.
string
Unique identifier of the Video Agent.
string
Display name of the Video Agent.
string
Avatar selected 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 indicating when the Video Agent was created.
integer
Current page number.
integer
Maximum number of records returned per page.
integer
Total number of Video Agents.
integer
Total number of available pages.

Error Handling

Use the returned Video Agent ID with:
  • GET /api/video-agent/{id} to retrieve a specific Video Agent.
  • PATCH /api/video-agent/{id} to update a Video Agent.
  • DELETE /api/video-agent/{id} to remove a Video Agent.