Get all Character Voices

GET

/api/v2/agents/character-voices

Retrieves a list of character voices with support for pagination and filtering.

Purpose:

Allows users to fetch character voices with optional filters such as search query, gender, and voice type.

Supports pagination and sorting to manage large datasets.

Query Parameters:

query (string, optional): Search term to filter character voices by name.

gender (string, optional): Filter by gender ('male' or 'female').

voice_type (string, optional): Filter by voice type ('azure_ai_speech' or 'openai').

paginated (boolean, optional): Toggle between paginated or full results.

page (int, optional): Page number (used if paginated=true).

items_per_page (int, optional): Items per page (used if paginated=true).

sort_by (string, optional): Sort by field. Default is "voice_name". Possible values: "voice_name", "gender", "voice_type". Add "-" before the field name to order in descending order.

Returns:

A list of serialized character voices based on applied filters.

Supports both paginated and unpaginated responses based on user preference.

If no character voices are found or if an error occurs, returns an appropriate error response.

Current Version:

2.0.0

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents/character-voices?gender=undefined&items_per_page=undefined&page=undefined&paginated=undefined&query=undefined&sort_by=undefined&voice_type=undefined' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "character_voices": [
            {
                "id": 0,
                "voice_name": "string",
                "voice_identifier": "string",
                "gender": "string",
                "voice_type": "string",
                "organization": 0,
                "is_default": true
            }
        ],
        "count": 0,
        "num_pages": 0,
        "current_page": 0
    }
}

Create or Update an Agent using the Agent Builder

Get Agent Filter