Documentação da API

A ClarixBI mantém um servidor MCP (Model Context Protocol), que permite conectar clientes compatíveis — como Claude Desktop e Claude Code — diretamente à nossa base de consultas, sem precisar implementar o wrapper de ferramenta manualmente.

https://clarixbiconsultas.com/api

Exemplo de configuração em um cliente MCP (formato ilustrativo — ajuste os nomes de ferramentas e o método de autenticação conforme a implementação do servidor):

{
  "mcpServers": {
    "clarixbi": {
      "url": "https://clarixbiconsultas.com/api",
      "headers": {
        "Authorization": "Bearer clx_live_xxxxxxxxxxxxxxxx"
      }
    }
  }
}

Este endpoint está em fase final de implantação. Caso encontre instabilidade ao conectar, tente novamente em alguns minutos ou entre em contato com o suporte.

Claude via API (tool use manual)

Se preferir não usar o servidor MCP — por exemplo, num backend próprio que já chama a API do Claude diretamente — defina a consulta como uma tool no formato do Claude e devolva o resultado da ClarixBI como tool_result:

{
  "name": "consultar_documento_clarixbi",
  "description": "Consulta dados cadastrais, score e situação de um CPF ou CNPJ na base da ClarixBI.",
  "input_schema": {
    "type": "object",
    "properties": {
      "modulo": {
        "type": "string",
        "description": "Código do módulo, ex: cpf-dados, cnpj-qsa, veicular-placa"
      },
      "documento": {
        "type": "string",
        "description": "CPF ou CNPJ a consultar, apenas números"
      }
    },
    "required": ["modulo", "documento"]
  }
}

const response = await fetch("https://api.anthropic.com/v1/messages", {
  method: "POST",
  headers: { "Content-Type": "application/json", /* auth do seu backend */ },
  body: JSON.stringify({
    model: "claude-sonnet-4-6",
    max_tokens: 1024,
    tools: [
      {
        name: "consultar_documento_clarixbi",
        description: "Consulta CPF ou CNPJ na base da ClarixBI.",
        input_schema: { /* ...schema acima... */ },
      },
    ],
    messages: [{ role: "user", content: "Verifique a situação do CPF 123.456.789-00" }],
  }),
});

// Quando Claude decidir usar a ferramenta, seu backend chama a ClarixBI
// (POST /api/v1/consulta) e devolve o resultado como tool_result.

ChatGPT / OpenAI (function calling)

O mesmo princípio se aplica ao formato de function calling da OpenAI, usado tanto na API quanto em GPTs personalizados:

{
  "type": "function",
  "function": {
    "name": "consultar_documento_clarixbi",
    "description": "Consulta dados cadastrais, score e situação de um CPF ou CNPJ na base da ClarixBI.",
    "parameters": {
      "type": "object",
      "properties": {
        "modulo": {
          "type": "string",
          "description": "Código do módulo, ex: cpf-dados, cnpj-qsa, veicular-placa"
        },
        "documento": {
          "type": "string",
          "description": "CPF ou CNPJ a consultar, apenas números"
        }
      },
      "required": ["modulo", "documento"]
    }
  }
}

LangChain, n8n e outros agentes

Frameworks de automação e orquestração de agentes (LangChain, n8n, Make, CrewAI, agentes internos) normalmente têm um bloco de "ferramenta HTTP" ou "webhook" genérico — basta apontá-lo para o mesmo endpoint REST, com a chave no header:

# Qualquer framework de agente que suporte "ferramentas HTTP"
# (LangChain, n8n, Make, CrewAI, agentes próprios) pode chamar
# o mesmo endpoint REST — basta repassar a chave clx_ no header.

POST https://clarix-bi.lovable.app/api/v1/consulta
Authorization: Bearer clx_live_xxxxxxxxxxxxxxxx
Content-Type: application/json

{ "modulo": "cnpj-dados", "documento": "12345678000199" }