Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
A resposta curta: na raiz da documentação há um ficheiro llms.txt: um índice em texto simples de todas as páginas, nas duas línguas, cada uma com a ligação para a sua versão em Markdown e uma frase sobre o que tem. No fim, a ligação para a especificação OpenAPI. É a forma mais rápida de pôr um assistente de IA a trabalhar com a nossa documentação, e não com o que ele julga saber.
O que tem o ficheiro
| Parte | O que diz |
| Cabeçalho | O nome da MozOut, o endereço base da API e o aviso de que cada página tem versão Markdown. |
| Documentação em português | Todas as páginas em português, com a ligação .md e a descrição. |
| Documentation in English | O mesmo, em inglês. |
| Specification | A ligação para a especificação OpenAPI. |
Como o usar com um assistente
|
|
|
Um pedido bem feito
Quanto mais preciso for o pedido, menos o assistente inventa. Um exemplo:
Lê o llms.txt desta documentação e as páginas Regras da API e SMS.
Escreve uma função em Python que envia um SMS pela API.
A chave vem da variável de ambiente RLX_API_KEY.
Envia sempre Idempotency-Key e espera o Retry-After depois de um 429.
Usa só operações que estejam na documentação.
| Nunca cole a chave da API numa conversa com um assistente. Ele não precisa dela para escrever o código; a chave entra só no ambiente onde o programa corre. E confirme o resultado: se o assistente usar uma operação que não está na lista «O que a API já faz», essa operação não existe. |
| O que é o llms.txt em geral, e se vale a pena no seu próprio site, está em llms.txt: o que é. |
|
Abra o índice e veja como está montado. Abrir o llms.txt |
PRODUTO RECOMENDADO Alojamento de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde $6.60/mês (plano de 3 anos, com cupão) Ver planos |
