API Overview
AuditorIA exposes a RESTful API built with FastAPI.
Base URL
- Development:
http://localhost:8000 - Production:
https://api.yourdomain.com
Authentication
All endpoints (except /health and /docs) require authentication via Keycloak.
You must include the Authorization header with a valid Bearer Token.
Authorization: Bearer <your_access_token>interactive Documentation
AuditorIA provides auto-generated Swagger UI documentation.
- Visit
/docsfor Swagger UI. - Visit
/redocfor ReDoc.
Key Resources
Tasks (/tasks)
POST /tasks/upload: Upload audio files for auditing.GET /tasks: List all transcription tasks.GET /tasks/{uuid}: Get result details.
Users (/users)
POST /users/sync: Sync users from Keycloak.GET /users/me: Get current user profile.
Stats (/stats)
GET /stats/dashboard: Get aggregated metrics for the dashboard.