> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weya.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Video Agents

> Retrieve all Video Agents available in your workspace.

## 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

<ParamField header="Authorization" type="string" required>
  Bearer token for authenticated workspace access.
</ParamField>

<ParamField query="page" type="integer">
  Page number to retrieve. Default is **1**.
</ParamField>

<ParamField query="limit" type="integer">
  Number of Video Agents returned per page.
</ParamField>

<ParamField query="search" type="string">
  Search Video Agents by name.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl --location '{{baseUrl}}/api/video-agent?page=1&limit=10&search=sales' \
  --header 'Authorization: Bearer {{authToken}}'
  ```
</RequestExample>

## Response

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "status": true,
    "code": 200,
    "message": "Video Agents fetched successfully",
    "data": [
      {
        "_id": "6891a23bc456def789123456",
        "agent_name": "Sales Video Agent",
        "avatar": "Business Female",
        "voice": "en-US-Standard-A",
        "language": "English",
        "status": "active",
        "createdAt": "2026-07-21T09:15:00.000Z"
      },
      {
        "_id": "6891a23bc456def789123457",
        "agent_name": "Support Video Agent",
        "avatar": "Customer Support",
        "voice": "en-US-Standard-B",
        "language": "English",
        "status": "active",
        "createdAt": "2026-07-20T15:42:10.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "total": 2,
      "totalPages": 1
    }
  }
  ```
</ResponseExample>

<ResponseField name="status" type="boolean">
  Indicates whether the request completed successfully.
</ResponseField>

<ResponseField name="code" type="integer">
  HTTP status code returned by the API.
</ResponseField>

<ResponseField name="message" type="string">
  Success message returned by the API.
</ResponseField>

<ResponseField name="data" type="array">
  List of Video Agents available in the authenticated workspace.
</ResponseField>

<ResponseField name="data._id" type="string">
  Unique identifier of the Video Agent.
</ResponseField>

<ResponseField name="data.agent_name" type="string">
  Display name of the Video Agent.
</ResponseField>

<ResponseField name="data.avatar" type="string">
  Avatar selected for the Video Agent.
</ResponseField>

<ResponseField name="data.voice" type="string">
  Voice assigned to the Video Agent.
</ResponseField>

<ResponseField name="data.language" type="string">
  Primary language configured for the Video Agent.
</ResponseField>

<ResponseField name="data.status" type="string">
  Current status of the Video Agent.
</ResponseField>

<ResponseField name="data.createdAt" type="string">
  Timestamp indicating when the Video Agent was created.
</ResponseField>

<ResponseField name="pagination.page" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="pagination.limit" type="integer">
  Maximum number of records returned per page.
</ResponseField>

<ResponseField name="pagination.total" type="integer">
  Total number of Video Agents.
</ResponseField>

<ResponseField name="pagination.totalPages" type="integer">
  Total number of available pages.
</ResponseField>

## Error Handling

| Status | Description                          |
| ------ | ------------------------------------ |
| 400    | Invalid request parameters           |
| 401    | Unauthorized or invalid Bearer token |
| 500    | Internal server error                |

<Check>
  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.
</Check>