docs: add AI quiz generation endpoint documentation
This commit is contained in:
@@ -34,6 +34,16 @@ SPDX-License-Identifier: MPL-2.0
|
|||||||
</div>
|
</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
|
## About ClassQuiz
|
||||||
|
|
||||||
ClassQuiz is a quiz app to learn interactively for students,
|
ClassQuiz is a quiz app to learn interactively for students,
|
||||||
|
|||||||
Reference in New Issue
Block a user