KonPro Logo

Get All Voices

GET/v1/voices

Retrieve a list of all available voices.

Request History

Log in to see full request history

TIMESTATUSUSER AGENT
Make a request to see history.

0 Requests This Month

Query Parameters

ParameterTypeDescription
scopestringFilter voices by scope. Options: all, public, private
languagestringFilter by language code (e.g., en-US, es-ES)
genderstringFilter by gender. Options: male, female, neutral
pageintegerPage number for pagination (default: 1)
limitintegerNumber of items per page (default: 20)

Request Example

shell
curl -X GET https://api.konpro.ai/v1/voices \
  -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json"

Response

Voices Array

voices: An array containing voice details.

FieldTypeDescription
idstringUnique identifier of the voice
namestringName of the voice
languagestringLanguage code of the voice (e.g., en-US)
genderstringGender of the voice: male, female, or neutral
preview_urlstringURL to the voice preview audio
propertiesobjectVoice properties object containing accent, age, and style

Pagination Object

pagination: Pagination information for the response.

FieldTypeDescription
pageintegerCurrent page number
limitintegerNumber of items per page
totalintegerTotal number of voices
total_pagesintegerTotal number of pages

Sample Successful Response

json
{
  "voices": [
    {
      "id": "voice-123",
      "name": "Jessica",
      "language": "en-US",
      "gender": "female",
      "preview_url": "https://...",
      "properties": {
        "accent": "American",
        "age": "adult",
        "style": "conversational"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "total_pages": 3
  }
}

Notes

  • This endpoint requires authentication using the x-api-key header.
  • Use the scope parameter to filter voices by visibility (all, public, private).
  • Use the language parameter to filter by language code.
  • Use the gender parameter to filter by gender (male, female, neutral).
  • Results are paginated. Use page and limit parameters to navigate through results.
  • For error descriptions, see Error Responses.

Table of Contents

Delete AvatarVideo Generation