Use com IA
llms.txt, Markdown de cada página e instruções para assistentes de programação.
Esta documentação foi feita para ser lida também por assistentes de IA (Cursor, Claude Code, Copilot, ChatGPT, Lovable, Bolt…). Dê a eles a fonte certa e o código sai funcionando de primeira.
Arquivos para a IA
| Arquivo | O que tem |
|---|---|
/llms.txt | Índice da documentação, com um link para cada página |
/llms-full.txt | A documentação inteira (guias e referência) em um só arquivo Markdown |
/{página}.md | Cada página em Markdown (ex.: /webhooks.md) |
/openapi.json | O contrato OpenAPI 3.1, para gerar clientes e SDKs |
Agentes que pedem Accept: text/markdown recebem o Markdown no próprio endereço da página, sem o .md.
Em toda página, o botão Copiar página leva o conteúdo em Markdown para colar no chat da IA; no menu ao lado, Abrir no ChatGPT ou Abrir no Claude já abre a conversa com a página como contexto.
Prompt para começar
Leia https://developer.onzap.io/llms-full.txt. Vou integrar meu sistema com a API de WhatsApp da OnZap.
Regras:
- Chamadas só no servidor, com o header X-Instance-Token (token em variável de ambiente ONZAP_TOKEN).
- Endereço base: https://app.onzap.io/v1/instances/{ONZAP_INSTANCE}.
- Para receber mensagens, crie um endpoint de webhook que confere o X-OnZap-Signature e assine message.any.
- Trate erros pelo campo error.code.
Agora: <descreva o que você quer construir>Dicas para o código gerado ficar certo
- Token nunca no front-end. Se a IA colocar a chamada no navegador, peça para mover para uma rota do servidor.
- Use o
chatIddo evento para responder, inclusive quando vier@lid. - Confira a assinatura com o corpo cru do webhook e responda
2xxrápido. - Descarte eventos repetidos pelo
iddo envelope. - Mídia recebida: baixe o arquivo pelo link em até 24 horas.