Pular para o conteúdo

Começar

Construir com IA

Como dar ao Claude Code, ao Cursor ou ao ChatGPT o contexto certo da documentação do Messajo, com llms.txt, Markdown por página e OpenAPI.

Um assistente de código acerta mais quando lê a documentação de verdade em vez de adivinhar a API. O Messajo publica a doc em formatos feitos para isso.

O quê Onde Para quê
Índice da doc https://docs.messajo.com/llms.txt Índice curto: descrição da API e links para a doc completa, a resumida e o OpenAPI. Para ler uma página só, use o .md dela
Doc completa https://docs.messajo.com/llms-full.txt Tudo em um arquivo só, para colar em um contexto grande
Doc resumida https://docs.messajo.com/llms-small.txt Versão abreviada, para contexto pequeno
Uma página <url da página>.md A página em Markdown puro
OpenAPI /openapi.pt-BR.json Contrato exato de cada rota, corpo e erro

Os arquivos llms*.txt são gerados a partir das páginas em português.

Acrescente .md ao fim do endereço de qualquer página:

https://docs.messajo.com/start/quickstart.md
https://docs.messajo.com/en/start/quickstart.md
https://docs.messajo.com/es/start/quickstart.md

Ao lado do título de cada página há o controle Copiar página. Ele copia o Markdown da página para a área de transferência e, no menu, oferece Ver como Markdown, Abrir no ChatGPT e Abrir no Claude. Os dois últimos abrem o assistente com um pedido para ler aquela página.

O contrato da API está em JSON, um arquivo por idioma:

A referência interativa é gerada do mesmo arquivo, e os tipos do SDK TypeScript também. Entregue o OpenAPI quando o assistente precisar do formato exato de um corpo de requisição.

O caminho é o mesmo no Claude Code, no Cursor e em outros assistentes de código:

  1. Na conversa. Cole o endereço do llms.txt ou do .md da página e peça para ler antes de escrever código.
  2. No arquivo de instruções do projeto. Escreva o endereço uma vez no arquivo que o seu assistente lê no começo de cada sessão (como o CLAUDE.md ou as regras do projeto), e toda sessão começa com a doc à mão.
  3. Para formatos exatos. Dê o openapi.json ou o .md da página da rota em questão, em vez de pedir para o assistente lembrar.

Exemplo de trecho para o arquivo de instruções:

API do Messajo (WhatsApp, Instagram e Messenger oficiais):
- Índice da documentação: https://docs.messajo.com/llms.txt
- Contrato da API: https://docs.messajo.com/openapi.json
- Antes de escrever código que chama a API, leia a página .md da rota.
- Use o SDK @messajo/sdk; nunca invente campos fora do OpenAPI.

Todo erro da API tem o mesmo corpo, com três campos úteis para quem está depurando (veja Formato do erro):

  • code: identificador estável, seguro para tratar no código.
  • docs_url: link para o code em Erros, com o significado e o que fazer.
  • request_id: o mesmo valor do cabeçalho X-Request-Id (veja X-Request-Id para suporte).

Cole o corpo do erro inteiro no assistente: o docs_url leva a explicação certa.

Um bom primeiro pedido, com o llms.txt já na conversa:

Leia https://docs.messajo.com/send/text.md e https://docs.messajo.com/webhooks/verify-signature.md.
Depois, com o @messajo/sdk:
1. envie um texto para 5511999999999 usando a chave em MESSAJO_API_KEY;
2. crie um endpoint que receba webhooks e verifique a assinatura Messajo-Signature
antes de tratar o evento.
Se algum campo não estiver na documentação, pergunte em vez de inventar.

Páginas de apoio: Enviar texto e Verificar a assinatura.