← Voltar

Learn

Como configurar a API do seu agente no Logcomex.AI

O Logcomex.AI permite transformar qualquer missão publicada em um endpoint HTTP POST pronto para integração com seus sistemas. Este artigo cobre o…

21 de outubro de 2026

Como configurar a API do seu agente no Logcomex.AI

O Logcomex.AI permite transformar qualquer missão publicada em um endpoint HTTP POST pronto para integração com seus sistemas. Este artigo cobre o processo completo — da chave de acesso até o Swagger UI para testes.

Quem pode configurar

Apenas criadores e administradores da conta. Se a aba API não aparece na edição do agente, verifique sua permissão de admin.

Passo a passo: os 6 passos da configuração

Passo 1 — Acesse o agente

  1. Na lista de agentes, localize o agente desejado.
  2. Clique nos três pontinhos (⋮) no canto superior direito do card.
  3. Selecione Editar.

Passo 2 — Aba API

Dentro da modal de configuração, clique na aba API (marcada como NOVO). Se a aba não aparece, verifique a permissão de administrador.

Passo 3 — Crie a API Key

  1. Dentro da aba API, clique no botão para gerar uma nova chave.
  2. A chave é gerada no formato ldi_*.
  3. Copie e guarde imediatamente. Ela aparece apenas uma vez — após fechar a tela, não é possível recuperá-la.
  4. Use a chave em todas as chamadas no header: Authorization: Bearer ldi_xxx.

Sem a API Key, a requisição é rejeitada com erro 401.

Em caso de vazamento da chave: gere uma nova e revogue a anterior imediatamente.

Passo 4 — Publique a missão

Cada endpoint é gerado a partir de uma missão vinculada ao agente.

  1. Na aba API, visualize a lista de missões disponíveis. Há dois tipos:
    • Empresa: missões criadas por você.
    • Sistema: missões padrão da plataforma — precisam ser copiadas/duplicadas para a sua conta antes de publicar.
  2. Localize a missão desejada e ative o toggle Publicar.
  3. O status "Publicado" (laranja) confirma que o endpoint está ativo.
  4. Copie a URL do endpoint gerado: POST https://api.logcomex.ai/v1/agent-api-execute/...

Passo 5 — Gere os Schemas

Os Schemas definem os campos de entrada (Input) e a estrutura de resposta (Output) da sua API.

Input Schema:

  1. Clique em Schemas do endpoint desejado.
  2. Visualize as variáveis do template do prompt — cada variável vira um parâmetro da API.
  3. Renomeie as variáveis se necessário para clareza.
  4. Clique em "Gerar do Template" — o JSON de input é gerado automaticamente.

Output Schema:

  1. Na mesma tela, role até Output Schema.
  2. Clique em "Gerar com IA" — a IA lê o prompt e estrutura o JSON de retorno automaticamente.
  3. Revise e clique em Salvar.

Passo 6 — Swagger UI

O Swagger UI é a documentação técnica completa e permite testes ao vivo diretamente no browser.

  1. Na aba API, clique em "Abrir Swagger UI".
  2. Clique em Authorize, cole a API Key e confirme.
  3. Visualize todos os endpoints com URL, método e parâmetros.
  4. Execute requisições reais e veja a resposta.

Erros mais comuns

CódigoSignificado
401Header Authorization ausente, formato inválido ou API Key revogada/expirada
422Erro de validação nos parâmetros enviados

Uma nota sobre CSV e nomes de colunas

Se a API retorna PDF quando você pediu CSV, ou se os nomes de colunas variam entre execuções do mesmo prompt: são falhas no exportador — abra chamado. Não implemente mapeamentos de contorno na sua integração como solução definitiva — isso gera débito técnico que precisa ser desfeito quando o problema for corrigido na origem.

Configuração não realizada após a contratação

Se você contratou a API e a configuração técnica não foi concluída, abra chamado imediato informando a empresa, o contato técnico do cliente e o prazo da primeira reunião técnica. Configurações de API não realizadas têm prioridade de atendimento.

É mais fácil com a Logcomex