Retorna dados completos de um avatar, incluindo configurações e datasets vinculados.

Endpoint

POST /api/externalAPIs/public/tolkyReasoning/avatars/getAvatarInfo

Parâmetros

host_id
string
required

UUID do host proprietário do avatar.

avatar_id
string
required

UUID do avatar a ser consultado.

Exemplo

curl -X POST {{BASE_URL}}/api/externalAPIs/public/tolkyReasoning/avatars/getAvatarInfo \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "host_id": "uuid-do-host",
    "avatar_id": "uuid-do-avatar"
  }'

Resposta

{
  "code": 200,
  "message": "Success",
  "data": {
    "avatar": {
      "avatarId": "uuid-do-avatar",
      "hostId": "uuid-do-host",
      "subSlug": "meu-avatar",
      "avatarName": "Nome do Avatar",
      "avatarPicture": "https://exemplo.com/avatar.jpg",
      "promptEnvelop": "Você é um assistente...",
      "model": "gpt-4",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-02T00:00:00Z"
    },
    "config": {
      "id": "uuid-do-config",
      "avatarId": "uuid-do-avatar",
      "hostId": "uuid-do-host",
      "tickets": {
        "use_queue": true,
        "distribution_mode": "auto"
      },
      "nps": {
        "active": true,
        "maxScore": 10
      },
      "advisor": {
        "active": true
      }
    },
    "datasets": [
      {
        "datasetId": "uuid-do-dataset",
        "datasetName": "Base de Conhecimento",
        "expires": null,
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ]
  }
}

Campos da Resposta

data.avatar
object

Dados básicos do avatar.

data.config
object

Configurações avançadas do avatar.

data.datasets
array

Datasets vinculados ao avatar.

Erros

CódigoDescrição
400host_id ou avatar_id ausente ou inválido
403Token inválido ou sem permissão para este host
404Avatar não encontrado ou não pertence ao host informado
408Timeout — requisição excedeu 60 segundos
500Erro interno do servidor