SimuladoAI API Documentation

Documentação completa e interativa da API. Teste endpoints diretamente nesta interface.

Como Usar Esta Documentação

🔐 Autenticação

Para testar endpoints autenticados:

  1. Faça login através do endpoint POST /api/auth/login
  2. Copie o token JWT retornado
  3. Clique no botão "Authorize" no topo da documentação
  4. Cole o token no campo de autenticação

📝 Testando Endpoints

Cada endpoint possui um botão "Try it out" que permite:

  • Preencher parâmetros e corpo da requisição
  • Executar a chamada real à API
  • Ver a resposta completa (headers, body, status)
  • Copiar exemplos de código em várias linguagens

📊 Schemas

Na seção "Schemas" no final da página você encontra:

  • Estrutura completa de todos os objetos da API
  • Tipos de dados de cada campo
  • Campos obrigatórios vs opcionais
  • Exemplos de valores

⚡ Rate Limiting

Todos os endpoints possuem rate limiting baseado no tier do usuário:

  • FREE: 1000 créditos/dia
  • PREMIUM: Créditos diários ilimitados
  • ADMIN: Ilimitado

Cada resposta inclui informações de rate limit nos headers e no corpo da resposta.

Documentação gerada automaticamente com Swagger/OpenAPI 3.0