Ir para o conteúdo

Agentes

Se um agente de código vai escrever a sua integração, entregue https://occultapi.com/AGENTS.md a ele antes de tudo. É um resumo curto sobre as quatro coisas que os agentes quase sempre erram nesta API.

Entregue isto ao agente

Cole isto no seu agente antes de ele começar. É markdown puro, sem autenticação e com CORS liberado, então o agente consegue baixar sozinho.

Read https://occultapi.com/AGENTS.md before writing any code against Occult API.
Use the OpenAPI spec at https://occultapi.com/openapi.json for exact field names.

O que o arquivo diz, e por quê

Quatro regras. Cada uma existe porque é um erro que os agentes realmente cometem aqui, e não por ser um guia de estilo genérico.

  • Agrupe com keys, sem loop. Vários cálculos em uma única requisição custam um crédito; os mesmos cálculos em chamadas separadas custam um crédito cada. Um agente preocupado com código legível vai escrever o loop, e quem paga a conta é o seu saldo.
  • Não repita um 402. Ele quer dizer que a chave é válida e o saldo acabou. Se o agente tratar o erro como falha passageira, vai tentar de novo para sempre; se tratar como falha de autenticação, vai gerar outra chave no lugar de uma que funciona perfeitamente. Só vale tentar de novo com 429 e 5xx.
  • A chave fica só no servidor. A regra está explícita porque “chamar pelo cliente” é o caminho mais fácil, e ele deixa a sua chave pública.
  • Leia a especificação em vez de chutar nomes de campo. O documento OpenAPI traz todos os campos, os valores aceitos e um exemplo para cada endpoint, conferido em um servidor real na maioria dos casos. Uma leitura sai mais barato que três erros 400.

Se o seu agente fala MCP, prefira o MCP

Nosso servidor MCP dá acesso aos 299 endpoints por meio de cinco ferramentas, e buscar e ler schemas não consome créditos: só um cálculo de verdade consome. O agente pode explorar a API inteira de graça e só gastar quando calcula algo, o que sai mais barato e é mais confiável do que deixá-lo adivinhar a partir da documentação.

Leia você primeiro

Antes de entregar ao agente, vale gastar dois minutos lendo /AGENTS.md. Se o conselho estiver errado, é você quem vai descobrir.

Próximos passos