Bem-vindo à documentação da API LLMGenerator. Nossa API oferece acesso programático aos recursos principais do LLMGenerator, permitindo integrar geração e gestão de llms.txt diretamente em seus aplicativos.
URL base
Todos os endpoints da API são relativos à seguinte URL base:
https://api.llmgenerator.com/api/v1
Autenticação
A API LLMGenerator usa chaves de API para autenticar requisições. Você pode criar e gerenciar suas chaves em Configurações → Chaves de API.
Todas as requisições autenticadas devem incluir o cabeçalho Authorization com sua chave de API como token Bearer.
Authorization: Bearer YOUR_API_KEY
Mantenha suas chaves de API seguras. Não as compartilhe em áreas públicas como GitHub, código no lado do cliente, etc.
Métodos de geração
A API admite dois métodos de geração distintos:
| Método | Descrição | Custo em créditos |
|---|
| Simple | Geração rápida usando metadados da página. Melhor para resultados ágeis. | 1x |
| Enhanced | Geração com IA e títulos/descrições aprimorados. | 2x |
É possível informar o método com o parâmetro generationMethod no endpoint /generate. Usuários do plano gratuito só podem usar o método simple.
Sistema de créditos
O uso da API é medido em créditos:
- Geração simples: custo base de créditos por URL processada
- Geração enhanced: multiplicador 2x de créditos pelo processamento com IA
- Texto completo: créditos adicionais ao incluir o conteúdo integral da página
Consulte seu saldo com o endpoint /credits/balance.
Limitação de taxa (rate limiting)
As requisições são limitadas conforme seu plano. Se você ultrapassar o limite, receberá a resposta 429 Too Many Requests. Os cabeçalhos trazem informações do limite:
X-RateLimit-Limit: máximo de requisições por minuto
X-RateLimit-Remaining: requisições restantes na janela atual
X-RateLimit-Reset: instante em que a janela reinicia (epoch UTC em segundos)
Suporte a CORS
Endpoints públicos de arquivo (/file/:siteId) suportam CORS e podem ser acessados diretamente pelo navegador. Não exigem autenticação.
Erros
A API usa códigos HTTP padrão:
| Código | Descrição |
|---|
200 | Sucesso |
201 | Recurso criado |
400 | Requisição inválida (erro de validação) |
401 | Não autorizado (chave de API inválida/ausente) |
403 | Proibido (permissões insuficientes) |
404 | Recurso não encontrado |
429 | Limite de taxa excedido |
500 | Erro interno do servidor |
As respostas de erro incluem um corpo JSON:
{
"message": "Validation error: URL is required"
}
Webhooks
Para operações longas, você pode configurar URLs de webhook para receber notificações ao concluir jobs. Entre em contato com o suporte para habilitar webhooks na sua conta.