Pular para o conteúdo

llms.txt

llms.txt é um arquivo de texto em Markdown, na raiz do site, que lista as páginas da documentação com título, link e uma frase de descrição. Um agente de IA lê esse índice e decide quais páginas buscar, sem rastrear o site inteiro.

O arquivo é gerado a cada build do site e publicado em:

https://developers.owiew.com/llms.txt

Ele traz:

  • uma linha de apresentação do site;
  • o endereço da especificação OpenAPI da API de leitura (https://developers.owiew.com/openapi.json);
  • as páginas agrupadas por seção: API de leitura, aplicativos e loja, integrações, IA e MCP. Cada item é um link absoluto com a descrição da página.

Como o arquivo nasce do título e da descrição de cada página, ele acompanha a documentação sozinho: página nova entra no próximo build.

O site também publica o texto completo de todas as páginas em um único arquivo, para o agente ler a documentação inteira numa só requisição:

https://developers.owiew.com/llms-full.txt

O arquivo é gerado no mesmo build, depois do llms.txt, e o llms.txt aponta para ele. Cada página aparece com título, descrição, endereço público e o corpo em Markdown, sem o cabeçalho técnico. As páginas seguem a ordem do menu, agrupadas por seção. Os links internos já vêm com o endereço completo. A referência da API (gerada da especificação) não entra nele: para ela, use https://developers.owiew.com/openapi.json.

Se o arquivo passar de 2 MB, ele é dividido por seção e o llms-full.txt passa a listar as partes. Hoje ele cabe inteiro em um arquivo.

Prefira o llms.txt quando o agente só precisa localizar uma página; prefira o llms-full.txt quando precisa do conteúdo todo.

  1. Passe ao agente o endereço https://developers.owiew.com/llms.txt e peça que o leia primeiro. Para dar a documentação toda de uma vez, passe https://developers.owiew.com/llms-full.txt.
  2. Para trabalho com a API, passe também https://developers.owiew.com/openapi.json.
  3. Peça que cite a página de onde tirou cada regra.

Exemplo de instrução:

Antes de escrever qualquer chamada, leia https://developers.owiew.com/llms.txt
e abra as páginas da seção "API de leitura". Use somente rotas que estejam em
https://developers.owiew.com/openapi.json. Cite a página de cada regra que aplicar.

O agente começa pelo índice, abre só as páginas pertinentes e usa rotas que existem na especificação.

  • O agente diz que não achou o arquivo. Confira o endereço completo, com https://. Ferramentas que não acessam a internet precisam receber o texto colado na conversa.
  • O agente cita uma rota que não existe. Peça que confira a rota em /openapi.json antes de usá-la.