Get Avatar Detail by Name

Query detailed information of a specific avatar by its name. Searches both custom avatars (owned by the current license) and system avatars. Returns complete avatar configuration including provider settings, model, voice, prompt information, and provider name.

This endpoint is useful when you need to query avatar details using the avatar name instead of the ID, especially for WebSocket connections where the character name parameter is used.

GET /api/open/v1/avatar/getByName

Get Avatar Detail by Name

cURL

curl --request GET \
  --url https://api.navtalk.ai/api/open/v1/avatar/getByName \
  --header 'license: <api-key>'

200

Example

{
  "code": 200,
  "message": "SUCCESS",
  "data": {
    "id": "fbc269dcd0a738cf8e5e0f465671303c",
    "name": "navtalk.Leo",
    "url": "https://example.com/photo.jpg",
    "thumbnailUrl": "https://example.com/photo-thumbnail.jpg",
    "providerId": "b92a28fb2ea737457c7f13ba554759c0",
    "providerName": "openai",
    "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
    "voice": "CwhRBWXzGAHq8TQ4Fs17",
    "firstMessage": "Hi! How can I help you today?",
    "prompt": "You are a helpful assistant.",
    "videoFile": false,
    "status": "Success"
  }
}

Authorizations

license · string · header · required

NavTalk API license key (e.g. sk_navtalk_...)

Query Parameters

name · string · required

The avatar name to query (e.g., 'my-avatar' or system avatar like 'navtalk.Leo')

Example:

"navtalk.Leo"

Response

200

application/json

Avatar detail retrieved successfully

code · integer

Example:

200

message · string

Example:

"SUCCESS"

data · object

Show child attributes