Este endpoint permite criar um novo host no sistema, que serve como container principal para avatares e configurações.

Endpoint

POST /api/externalAPIs/public/tolkyReasoning/hosts/create

Parâmetros

ParâmetroTipoDescrição
user_namestringNome do usuário (obrigatório)
host_slugstringSlug único do host (obrigatório)
emailstringEmail do usuário (obrigatório)
host_start_commandsstringComandos iniciais do host (obrigatório)
host_quick_textstringTexto rápido do host (opcional)
host_interests_tagsstringTags de interesse do host (opcional)
host_picturestringURL da imagem do host (opcional)
host_descriptionstringDescrição do host (opcional)

Exemplo de Requisição

curl -X POST \
  '{BASE_URL}/api/externalAPIs/public/tolkyReasoning/hosts/create' \
  -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"
  }'

Exemplo de 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_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"
  }
}

Funcionamento

A rota hosts/create cria um novo host com as informações fornecidas. O host serve como container principal para avatares e suas configurações.

A requisição tem um timeout de 60 segundos para garantir uma resposta em tempo hábil.

Campos obrigatórios:

  • user_name: Nome do usuário proprietário do host
  • host_slug: Identificador único do host (deve ser único no sistema)
  • email: Email do usuário para contato
  • host_start_commands: Comandos ou mensagens iniciais do host

Códigos de Erro

  • 400: Campos obrigatórios ausentes (user_name, host_slug, email, host_start_commands)
  • 403: Credenciais inválidas ou sem permissão de acesso
  • 408: A requisição excedeu o limite de tempo de 60 segundos
  • 500: Erro interno do servidor ao processar a requisição

Notas

  • Requer autenticação válida através do tolkyAuthMiddleware
  • O host_slug deve ser único no sistema
  • Todos os campos são validados contra a estrutura da tabela hosts
  • Campos com valores nulos são automaticamente removidos antes da inserção