A documentação pronta para IA
Cada página das duas centrais em Markdown, o llms.txt, o llms-full.txt, o contrato OpenAPI e a coleção do Postman: o que a sua IA pode ler da NexTags.
As duas centrais da NexTags, a de Desenvolvedores e a Central de Ajuda, são feitas para pessoas e para IAs. Toda página tem uma versão em Markdown, cada central tem um índice para IA e a API tem um contrato OpenAPI. Assim, o ChatGPT, o Claude ou um agente seu leem a documentação atual, direto da fonte, em vez de responder de memória.
Como funciona
| O que | Onde | O que tem |
|---|---|---|
| Cada página em Markdown | O endereço da página com .md no lugar da barra final | O texto da página, sem menu nem visual. Links e imagens vêm com o endereço completo. |
| Índice para IA | /llms.txt e, na Central de Ajuda, /llms.txt | Todas as páginas da central, por seção, com o título, o resumo e o link do .md. As que ainda não têm o texto final aparecem com "(em produção)". |
| A central inteira | /llms-full.txt e, na Central de Ajuda, /llms-full.txt | Todas as páginas da central em Markdown, num arquivo só. |
| Contrato da API | /openapi.json, também em /.well-known/openapi.json | A API em OpenAPI 3.1, em português: endpoints, parâmetros, objetos, respostas e exemplos de código. |
| Coleção do Postman | /nextags.postman_collection.json | Uma pasta por recurso da API. Preencha a variável chave_api com a chave da sua conta. |
Os arquivos da API também estão em Arquivos para baixar, na Referência.
O Markdown de uma página
Troque a barra final do endereço por .md:
https://docs.nextags.com.br/webhooks/webhook-de-entrada/
https://docs.nextags.com.br/webhooks/webhook-de-entrada.mdO arquivo começa com o título, o resumo, o endereço da página e o tipo, e segue com o texto. Os blocos da página viram Markdown comum: os passos ganham títulos numerados ("Passo 1: …"), os avisos viram citações e o pedido de "Faça com a IA" vem num bloco de texto. Nas páginas da Referência, o Markdown traz o método e o caminho, as tabelas de parâmetros e de campos, o exemplo em cURL e as respostas.
# Webhook de entrada: receber dados de outro sistema
> Mande um JSON de outro sistema para o link de um webhook de entrada. ...
Endereço: https://docs.nextags.com.br/webhooks/webhook-de-entrada/
Tipo: GuiaOs arquivos .md, os llms*.txt, o openapi.json e a coleção respondem com o cabeçalho Access-Control-Allow-Origin: *: uma ferramenta no navegador também consegue ler. O robots.txt das duas centrais libera tudo (Allow: /) para buscadores e agentes de IA.
O menu de cada página
No topo de cada página, ao lado da data, fica o botão Copiar página. A seta ao lado abre o menu:
| Opção | O que faz |
|---|---|
| Copiar página | Copia o Markdown da página, pronto para colar numa conversa com a IA. |
| Ver como Markdown | Abre o .md da página numa nova aba. |
| Abrir no ChatGPT | Abre o ChatGPT com um pedido que manda ler o .md da página. |
| Abrir no Claude | Abre o Claude com o mesmo pedido. |
| Copiar link | Copia o endereço da página. |
Nos guias, o bloco Faça com a IA traz um pedido pronto, com o link do .md da página. O botão Copiar pedido copia o texto. Veja Atalhos para o ChatGPT e o Claude.
Quando usar
| Você quer… | Use |
|---|---|
| Tirar uma dúvida sobre uma página | Abrir no ChatGPT ou Abrir no Claude, no menu da página |
| Que a IA escreva o código de uma integração | O .md das páginas que importam e o /openapi.json. Veja Prompts prontos. |
| Dar a um projeto do ChatGPT ou do Claude o contexto da NexTags inteira | O /llms-full.txt das duas centrais e o /openapi.json, como arquivos do projeto |
| Que um agente seu ache a página certa sozinho | O /llms.txt: ele lê o índice e abre só os .md de que precisa |
| Gerar um cliente da API ou testar no Postman | O /openapi.json ou a coleção do Postman |
Boas práticas
Prefira o link à cópia
O .md no ar é sempre a versão atual. Uma cópia colada numa conversa ou num projeto fica velha quando a página muda: atualize os arquivos do projeto de tempos em tempos.
Dê à IA só o que importa
Para uma tarefa só, os .md de duas ou três páginas funcionam melhor do que a central inteira. Deixe o /llms-full.txt para os projetos que tratam de muitos assuntos.
Nunca mande a chave de API para a IA
A documentação não precisa da sua chave, e a IA também não: peça código que leia a chave de uma variável de ambiente, como NEXTAGS_API_KEY. Veja Autenticação com a chave de API.
Relacionados
Este conteúdo ajudou?
Obrigado! Sua resposta ajuda a melhorar a central.