Você pode testar esta rota diretamente em nossa documentação interativa.

Rotas disponíveis

Conversas

  • Criar Conversa — Gera um identificador único para iniciar uma nova conversa
  • Obter Informações da Conversa — Retorna resumo, análise de sentimento e metadados de uma conversa
  • Investigar Mensagem — Detalha uma mensagem por ID com custos de IA, chamadas externas e métricas de performance
  • Investigate V2 — Explica por que a IA respondeu de determinada forma a partir de instruções do gestor
  • Smart Feedback — Registra feedback positivo ou negativo sobre uma resposta do avatar

Avatares

  • Listar Avatares — Retorna todos os avatares e datasets associados a um host
  • Obter Avatar — Retorna dados completos de um avatar específico
  • Criar Avatar — Cria um novo avatar vinculado a um host
  • Editar Avatar — Atualiza as configurações de um avatar existente
  • Deletar Avatar — Remove um avatar do sistema (soft delete)

Hosts

  • Criar Host — Registra um novo host no sistema Tolky

Datasets

Blocos de Conteúdo

  • Ler Bloco — Lista os blocos de conteúdo de um dataset
  • Criar Bloco — Adiciona um novo bloco de conteúdo a um dataset
  • Editar Bloco — Atualiza o conteúdo de um bloco existente
  • Deletar Bloco — Remove um bloco de conteúdo

Fluxos de Automação

Relatórios

MCP


Endpoint

POST /api/externalAPIs/public/tolkyReasoning/callReasoning

Parâmetros

hostId
string (UUID)
required

Identificador único do host.

conversationId
string (UUID)
required

Identificador único da conversa.

question
string | null

Pergunta ou comando para processamento. Pode ser null em casos de rebounce.

hostSlug
string

Slug do host para identificação amigável.

originalDialogue
array
default: "[]"

Histórico do diálogo.

contextData
string

Dados contextuais adicionais (JSON serializado como string).

dialogueInsertString
string

Texto para inserção no diálogo.

subSlug
string

Sub-slug do host.

followup
boolean
default: "false"

Indica se é um followup automático.

userData
object

Dados do usuário para personalização e rastreamento.

reasoningConfig
object

Configurações de comportamento do processamento.

followupConfig
object

Configurações para followup automático.

globalData
any

Dados globais adicionais.

Exemplo

curl -X POST {{BASE_URL}}/api/externalAPIs/public/tolkyReasoning/callReasoning \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "hostId": "454960a8-7c78-4ee9-88cc-91b7beddf303",
    "conversationId": "63f75d81-b8fb-41f8-8a9c-39748c6f68f4",
    "question": "Olá, preciso de ajuda",
    "userData": {
      "userName": "João Silva",
      "email": "joao@exemplo.com"
    }
  }'

Resposta

{
  "code": 200,
  "message": "OK",
  "data": {
    "assistantResponse": {
      "string": "Olá! Como posso ajudar?",
      "wppParsed": [
        { "type": "text", "content": "Olá! Como posso ajudar?" }
      ],
      "isAudio": false,
      "mediaDescriptionArray": []
    },
    "responseStatus": {
      "ok": true,
      "message": null
    },
    "tokensControl": [
      { "model": "gpt-4o", "tokens": 250 }
    ],
    "sessionId": "uuid-da-sessao",
    "conversationId": "63f75d81-b8fb-41f8-8a9c-39748c6f68f4",
    "hostId": "454960a8-7c78-4ee9-88cc-91b7beddf303",
    "userId": null,
    "leadId": "uuid-do-lead",
    "askHumanHelp": false,
    "createdMessageIds": ["uuid-msg-1", "uuid-msg-2"],
    "requestControlId": "rc_uuid",
    "globalData": null
  }
}

Campos da Resposta

assistantResponse
object

Resposta do assistente.

responseStatus
object

Status do processamento. Sempre presente — valide antes de processar a resposta, mesmo com HTTP 200.

tokensControl
array

Consumo de tokens por modelo. Cada item: { model, tokens }.

sessionId
string
Identificador único da sessão.
conversationId
string
Identificador único da conversa.
hostId
string
Identificador único do host.
userId
string | null
Identificador do usuário.
leadId
string | null
Identificador do lead.
askHumanHelp
boolean
Indica se foi solicitada ajuda humana.
createdMessageIds
array
UUIDs das mensagens criadas durante o processamento.
requestControlId
string | null
ID de controle da requisição para rastreamento e auditoria.
mcp
object

Informações sobre execução de ferramentas MCP.

globalData
any | null

Dados completos do processamento interno. Retornado apenas com reasoningConfig.returnGlobalData: true. Use apenas para debugging avançado.

Sempre valide responseStatus.ok mesmo quando o HTTP retornar 200. Um valor false indica que o serviço está temporariamente indisponível — implemente retry com backoff exponencial (1s, 2s, 4s…).

wppParsed é um array de objetos, não um objeto simples. Sempre itere sobre ele: wppParsed.map(item => ...).

wppParsed — tipos suportados

TipoCamposDescrição
texttype, contentTexto simples ou com *negrito*
imagetype, content, url, descriptionImagens (jpg, png, gif, webp)
sitetype, content, url, descriptionLinks para sites
audiotype, content, url, descriptionArquivos de áudio (mp3, wav)
documenttype, content, url, descriptionDocumentos (pdf, doc, xls)
boletotype, contentLinha digitável (47 ou 48 dígitos)
pixtype, contentCódigo PIX Copia e Cola (EMVCo)

Erros

CódigoDescrição
400Parâmetros inválidos
401Token inválido ou ausente
403Credenciais insuficientes
408Timeout — requisição excedeu 60 segundos
500Erro interno do servidor
503Serviço temporariamente indisponível (também sinalizado via responseStatus.ok: false com HTTP 200)