diff --git a/README.md b/README.md index 044039b..dd3e463 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,16 @@ SPDX-License-Identifier: MPL-2.0 +## AI Quiz Generation + +ClassQuiz-AI includes an OpenAI-compatible API endpoint for generating quizzes dynamically using LLMs. + +- **Endpoint**: `POST /api/v1/ai/generate` +- **Environment Variables**: + - `AI_API_KEY`: API key for your LLM provider. + - `AI_BASE_URL`: Base URL (defaults to `https://api.openai.com/v1`). + - `AI_MODEL`: Model name (defaults to `gpt-4o-mini`). + ## About ClassQuiz ClassQuiz is a quiz app to learn interactively for students,