Skip to main content

Overview

Retrieve all available voices that can be used when creating or updating a Video Agent. The response may vary depending on the selected video generation mode, allowing your application to display only compatible voices.

Prerequisites

  • Bearer Token authentication

Request

string
required
Bearer token for authenticated workspace access.
string
(Optional) Video generation mode used to filter compatible voices.

Response

boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Success message returned by the API.
array
Collection of voices available for the selected video mode.
string
Unique identifier of the voice.
string
Display name of the voice.
string
Language supported by the voice.
string
Gender of the voice.
string
Voice provider used by the platform.

Error Handling

The available voices may differ depending on the selected video generation mode and the configured speech provider.
Use the returned Voice ID when creating or updating a Video Agent.