docs: add AI quiz generation endpoint documentation

2026-07-28 09:30:01 -04:00
parent d0ed79a986
commit 7d2a309d0f
1 changed files with 10 additions and 0 deletions
@@ -34,6 +34,16 @@ SPDX-License-Identifier: MPL-2.0
 </div>


+## 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,