List Brand Voices
GET
https://api.konpro.ai/v1/brand_voice/listRetrieve a list of brand voices created under your account. Supports pagination and optional retrieval of only voice names.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
cURL Request
shell
curl --request GET \
--url 'https://api.konpro.ai/v1/brand_voice/list?limit=100' \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum number of brand voices to return (default: 100) |
| token | string | Pagination token for fetching additional pages |
| name_only | boolean | When true, returns only the names of brand voices |
Response
Response Structure
| Field | Type | Description |
|---|---|---|
| brand_voices | array | Array of brand voice objects or names based on name_only parameter |
Sample Response
json
{
"brand_voices": [
{
"id": "voice_123",
"name": "Professional Male Voice",
"language": "en-US",
"gender": "male",
"age_range": "adult",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": "voice_456",
"name": "Friendly Female Voice",
"language": "en-US",
"gender": "female",
"age_range": "young_adult",
"created_at": "2024-01-14T15:45:00Z",
"updated_at": "2024-01-14T15:45:00Z"
}
],
"total_count": 2,
"has_more": false
}Notes
- Requires API authentication.
- Supports pagination with limit and token parameters.
- Use name_only=true to retrieve only voice names for faster response.
- Default limit is 100 brand voices per request.
- Returns empty array if no brand voices exist.
- All timestamps are in ISO 8601 format (UTC).
- Refer to Error Responses for error information.
Example Usage
Shell
curl --request GET \
--url 'https://api.konpro.ai/v1/brand_voice/list?limit=100' \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'LANGUAGE
CREDENTIALS
HEADER
RESPONSE
Examples
Choose an example:
application/json
200 - Success
400 - Bad Request
LANGUAGE
CREDENTIALS
HEADER
RESPONSE
Examples
Choose an example:
application/json
200 - Success
400 - Bad Request