Get All Agentic Avatars
GET
/v1/agentic-avatarsRetrieve a list of all agentic avatars.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
Query Parameters
All query parameters are optional. Use them to filter and paginate the results.
| Parameter | Type | Description |
|---|---|---|
| page | integer optional | Page number for pagination. Default: 1 |
| limit | integer optional | Number of items per page. Default: 20 |
| status | string optional | Filter by status. Options: active or inactive. If not specified, all agentic avatars are returned regardless of status. |
Request Example
shell
curl -X GET "https://api.konpro.ai/v1/agentic-avatars?page=1&limit=20&status=active" \
-H "x-api-key: <your-api-key>" \
-H "Content-Type: application/json"Response
| Field | Type | Description |
|---|---|---|
| agentic_avatars | array | Array of agentic avatar objects. Each object contains the agentic avatar details. |
| pagination | object | Pagination information object containing page, limit, total, and total_pages |
Agentic Avatar Object
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier of the agentic avatar |
| name | string | Name of the agentic avatar |
| avatar_id | string | The avatar ID used in this agentic avatar |
| voice_id | string | The voice ID used in this agentic avatar |
| brain_id | string | The knowledge base (brain) ID used in this agentic avatar |
| status | string | Current status of the agentic avatar (e.g., active or inactive) |
| created_at | string | ISO 8601 timestamp of when the agentic avatar was created |
Pagination Object
| Field | Type | Description |
|---|---|---|
| page | integer | Current page number |
| limit | integer | Number of items per page |
| total | integer | Total number of agentic avatars matching the query |
| total_pages | integer | Total number of pages available |
Sample Successful Response
json
{
"agentic_avatars": [
{
"id": "72e527cd-9d40-47a7-8c9d-753f945a7574",
"name": "Customer Support Agent",
"avatar_id": "avatar-3655",
"voice_id": "fa4954b5-dd32-47b7-8e11-b552ca35c13f",
"brain_id": "002a9215-dc48-4537-91cb-93ac182e4e93",
"status": "active",
"created_at": "2024-01-01T00:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 5,
"total_pages": 1
}
}Notes
- This endpoint requires authentication using the
x-api-keyheader. - All query parameters are optional. If not specified, the endpoint returns all agentic avatars with default pagination.
- Use the
statusparameter to filter by active or inactive agentic avatars. - The response includes pagination information to help you navigate through multiple pages of results.
- Only agentic avatars that belong to your account are returned.
- For error descriptions, see Error Responses.