Appearance
llms.txt
O padrão llms.txt é um arquivo de texto plano que permite que modelos de linguagem (LLMs) como ChatGPT, Claude, Gemini e outros compreendam a API Vitry de forma eficiente.
O que é
Inspirado no robots.txt (que orienta robôs de busca), o llms.txt é um arquivo que descreve sua API em um formato otimizado para inteligência artificial. Quando uma IA precisa entender como integrar com sua loja, ela pode consumir esse arquivo e ter todo o contexto necessário.
Arquivos disponíveis
| Arquivo | Descrição | Uso |
|---|---|---|
/llms.txt | Resumo da API com links para cada seção | Quando a IA precisa de uma visão geral rápida |
/llms-full.txt | Documentação completa da API em texto plano | Quando a IA precisa de todos os detalhes para gerar código |
Como usar
Com ChatGPT, Claude ou outra IA
Cole a URL do arquivo no chat da IA:
Leia https://docs.vitry.com.br/llms-full.txt e me ajude a criar
uma integração que sincronize produtos do meu ERP com a loja Vitry.Em ferramentas de desenvolvimento com IA
Adicione o llms-full.txt como contexto no seu projeto. Exemplo com Claude Code (arquivo CLAUDE.md):
markdown
# Vitry API
Documentação completa: https://docs.vitry.com.br/llms-full.txtExemplo com Cursor (arquivo .cursorrules):
Para integrar com a API Vitry, consulte: https://docs.vitry.com.br/llms-full.txtVia API (programático)
bash
curl https://docs.vitry.com.br/llms-full.txtConteúdo
Os arquivos incluem toda a documentação da API:
- Autenticação (API Keys)
- Formato de respostas e erros
- CRUD completo de Produtos, Variantes, Categorias, Marcas e Atributos
- Gerenciamento de Pedidos e Clientes
- Webhooks (eventos, assinatura, retentativas)
- Exemplos de request/response em JSON
Saiba mais
O padrão llms.txt foi proposto para facilitar a comunicação entre documentações e modelos de IA. Para mais informações: llmstxt.org