Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 1.52 KB

File metadata and controls

73 lines (51 loc) · 1.52 KB

API Documentation

This directory contains documentation for all API endpoints in Interview Genie.

Authentication

User Management

Interview Features

Document Management

API Response Format

All API responses follow this standard format:

{
  "success": boolean,
  "data": object | null,
  "error": string | null,
  "meta": {
    "timestamp": string,
    "requestId": string
  }
}

Error Handling

Common error status codes:

  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 429: Too Many Requests
  • 500: Internal Server Error

Rate Limiting

  • 3 attempts per 5 minutes for authentication
  • 100 requests per minute for authenticated endpoints
  • 50 requests per day for AI-powered features

Authentication

All protected endpoints require a valid JWT token in the Authorization header:

Authorization: Bearer <token>

Environment Variables

Required environment variables for API functionality are documented in .env.example