Skip to main content
GET
/
api
/
open
/
v1
/
avatar
/
detail
Get Avatar Detail
curl --request GET \
  --url https://api.navtalk.ai/api/open/v1/avatar/detail \
  --header 'license: <api-key>'
{ "code": 200, "message": "SUCCESS", "data": { "id": "fbc269dcd0a738cf8e5e0f465671303c", "name": "my-image-avatar", "url": "https://example.com/photo.jpg", "providerId": "b92a28fb2ea737457c7f13ba554759c0", "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

​
avatarId
string
required

The avatar ID to query

Example:

"fbc269dcd0a738cf8e5e0f465671303c"

Response

Avatar detail retrieved successfully

​
code
integer
Example:

200

​
message
string
Example:

"SUCCESS"

​
data
object