Get Single Agentic Avatar
GET
/v1/agentic-avatars/{agentic_avatar_id}Retrieve details of a specific agentic avatar.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| agentic_avatar_id | string | The unique identifier of the agentic avatar. You can find agentic avatar IDs using the Get All Agentic Avatars endpoint. |
Request Example
shell
curl -X GET https://api.konpro.ai/v1/agentic-avatars/{agentic_avatar_id} \
-H "x-api-key: <your-api-key>" \
-H "Content-Type: application/json"Response
| 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 |
| settings | object | Settings object containing greeting, personality, languages, and max_conversation_length |
| 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 |
| updated_at | string | ISO 8601 timestamp of when the agentic avatar was last updated |
| usage | object | Usage statistics object containing total_sessions, total_messages, and last_used |
Settings Object
| Field | Type | Description |
|---|---|---|
| greeting | string | The initial greeting message the avatar uses when starting a conversation |
| personality | string | Description of the avatar's personality and communication style |
| languages | array | Array of language codes that the avatar can understand and respond in |
| max_conversation_length | integer | Maximum number of messages in a conversation before the session is reset |
Usage Object
| Field | Type | Description |
|---|---|---|
| total_sessions | integer | Total number of widget sessions created using this agentic avatar |
| total_messages | integer | Total number of messages processed by this agentic avatar across all sessions |
| last_used | string | ISO 8601 timestamp of when the agentic avatar was last used in a widget session |
Sample Successful Response
json
{
"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",
"settings": {
"greeting": "Hello! How can I assist you today?",
"personality": "professional and helpful",
"languages": ["en", "es", "fr"],
"max_conversation_length": 50
},
"status": "active",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"usage": {
"total_sessions": 150,
"total_messages": 3200,
"last_used": "2024-01-01T00:00:00Z"
}
}Notes
- This endpoint requires authentication using the
x-api-keyheader. - Replace
{agentic_avatar_id}in the URL with the actual agentic avatar ID you want to retrieve. - The
agentic_avatar_idmust be a valid agentic avatar ID from your account. Use the Get All Agentic Avatars endpoint to find available agentic avatars. - The response includes detailed settings and usage statistics that are not available in the list endpoint.
- The
usageobject provides insights into how the agentic avatar has been used, including total sessions and messages. - For error descriptions, see Error Responses.