Skip to main content

Por que existem esses arquivos

Assistentes e IDEs com IA precisam de contexto em texto sobre a API para sugerir código, revisar integrações e responder dúvidas sem alucinar endpoints inexistentes. Publicamos dois arquivos estáticos para isso:
ArquivoUso recomendado
llms-full.txtDocumentação completa em texto plano — ideal quando você quer o máximo de detalhe no contexto (referência de endpoints, exemplos, regras).
llms.txtVersão resumida — útil quando o limite de contexto é menor ou você só precisa de um panorama antes de mergulhar na referência web.

Como usar o llms-full.txt

  1. Baixe ou copie o conteúdo de llms-full.txt (é um único arquivo de texto).
  2. Inclua no contexto da ferramenta:
    • Em editores como o Cursor: anexe o arquivo na conversa, coloque na pasta do projeto como referência ou use em regras/instruções do agente, conforme o fluxo da ferramenta.
    • Em chats (ChatGPT, Claude, etc.): cole trechos relevantes ou o arquivo inteiro se couber no limite do modelo.
  3. Atualize quando a doc mudar — o site é a fonte viva; regenere ou baixe de novo o llms-full.txt após releases importantes da API.

Quando preferir o llms.txt

Use llms.txt para uma visão compacta (visão geral, links conceituais) e combine com a documentação online para detalhes de cada endpoint. É uma boa porta de entrada antes de carregar o arquivo completo.
Os arquivos complementam, não substituem, os exemplos deste site e os testes na sua conta. Sempre confira parâmetros obrigatórios e códigos de erro na referência publicada.