Cria um novo host no domínio do token. Exige user_name, host_slug e email; os demais campos são opcionais.

Endpoint

POST /api/externalAPIs/public/tolkyReasoning/hosts/createHostsHelper

Parâmetros

user_name
string
required

Nome do usuário/host.

host_slug
string
required

Identificador amigável do host. Sanitizado automaticamente. Deve ser único por domínio.

email
string
required

Email do host. Normalizado automaticamente; avisos em validation_warnings quando houver correções.

host_picture
string

URL da imagem do host. Deve ser URL válida; inválida retorna 400.

host_quick_text
string

Texto rápido do host (opcional).

host_description
string

Descrição do host (opcional).

host_start_commands
array

Comandos de início (opcional). Avisos em validation_warnings quando houver correções.

host_interests_tags
array

Tags de interesse (opcional). Avisos em validation_warnings quando houver correções.

Exemplo

curl -X POST '{{BASE_URL}}/api/externalAPIs/public/tolkyReasoning/hosts/createHostsHelper' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_name": "João Silva",
    "host_slug": "joao-silva-host",
    "email": "joao@exemplo.com",
    "host_start_commands": [
      { "title": "Sobre", "description": "Olá, Gostaria de saber mais." },
      { "title": "Contato", "description": "Como faço para entrar em contato?" }
    ],
    "host_quick_text": "Assistente especializado em atendimento",
    "host_interests_tags": ["Veículos", "Tecnologia", "inovação"],
    "host_picture": "https://exemplo.com/avatar.jpg",
    "host_description": "Host para gerenciar avatares da empresa"
  }'

Resposta

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": "uuid-do-host",
    "user_name": "João Silva",
    "host_slug": "joao-silva-host",
    "email": "joao@exemplo.com",
    "host_quick_text": "Assistente especializado em atendimento",
    "host_interests_tags": ["Veículos", "Tecnologia", "inovação"],
    "host_picture": "https://exemplo.com/avatar.jpg",
    "host_start_commands": [
      { "title": "Sobre", "description": "Olá, Gostaria de saber mais." },
      { "title": "Contato", "description": "Como faço para entrar em contato?" }
    ],
    "host_description": "Host para gerenciar avatares da empresa",
    "domain_id": "uuid-do-dominio",
    "host_token": "token-de-acesso-do-host"
  }
}

A resposta pode incluir validation_warnings quando houve correções/normalizações em email, host_start_commands ou host_interests_tags.

Campos da Resposta

data
object

Erros

CódigoDescrição
400Validação falhou: domainId ausente; user_name, host_slug ou email ausentes; host_picture com URL inválida.
403Token ausente ou inválido
500Erro interno do servidor

Notas

  • Requer token Bearer no header Authorization.
  • O token deve estar associado a um domínio com domainId; caso contrário retorna 400.
  • O host_slug é sanitizado e deve ser único por domínio.
  • Campos com valores nulos são removidos antes da inserção. Caches relacionados ao host são invalidados após a criação (best-effort).