# Quiz Quail

## Docs

- [Generate a quiz with AI](https://docs.quiz-quail.com/api-reference/ai/generate-a-quiz-with-ai.md): Use AI to generate a complete quiz from a topic. Returns a Server-Sent Events stream with progress updates and the final quiz.
- [Generate promotion suggestions](https://docs.quiz-quail.com/api-reference/ai/generate-promotion-suggestions.md): Use AI to generate promotion suggestions for a quiz (platform recommendations, timing, SEO, and enhanced metadata). Returns a Server-Sent Events stream. Results are cached per quiz.
- [Delete media](https://docs.quiz-quail.com/api-reference/media/delete-media.md): Delete a media file from storage and the database.
- [Get signed upload URL](https://docs.quiz-quail.com/api-reference/media/get-signed-upload-url.md): Get a presigned URL for uploading large files directly to storage.
- [List media](https://docs.quiz-quail.com/api-reference/media/list-media.md): List uploaded media files with cursor pagination. Optionally filter by MIME type.
- [Search external media](https://docs.quiz-quail.com/api-reference/media/search-external-media.md): Search external media sources (Pexels images/videos, Freesound audio, Wikipedia images) for use in quizzes.
- [Upload media](https://docs.quiz-quail.com/api-reference/media/upload-media.md): Upload a media file (image, video, or audio) via multipart/form-data. Max 10MB for images/audio, 50MB for video.
- [API Reference](https://docs.quiz-quail.com/api-reference/overview.md): Complete reference for all Quiz Quail API endpoints
- [Create a question](https://docs.quiz-quail.com/api-reference/quizzes/create-a-question.md): Add a new question to a round. Default content is generated based on question_type if not provided.
- [Create a quiz](https://docs.quiz-quail.com/api-reference/quizzes/create-a-quiz.md): Create a new quiz with an optional title. A default first round is created automatically.
- [Create a round](https://docs.quiz-quail.com/api-reference/quizzes/create-a-round.md): Add a new round to a quiz. Automatically assigned the next position.
- [Delete a question](https://docs.quiz-quail.com/api-reference/quizzes/delete-a-question.md): Delete a question. Remaining questions in the round are re-ordered.
- [Delete a quiz](https://docs.quiz-quail.com/api-reference/quizzes/delete-a-quiz.md): Permanently delete a quiz and all its rounds and questions.
- [Delete a round](https://docs.quiz-quail.com/api-reference/quizzes/delete-a-round.md): Delete a round and its questions. Remaining rounds are re-ordered.
- [Duplicate a quiz](https://docs.quiz-quail.com/api-reference/quizzes/duplicate-a-quiz.md): Create a deep copy of a quiz including all rounds and questions.
- [Get a quiz](https://docs.quiz-quail.com/api-reference/quizzes/get-a-quiz.md): Get a quiz by ID with all rounds, questions, and theme.
- [List questions](https://docs.quiz-quail.com/api-reference/quizzes/list-questions.md): List all questions in a round, ordered by position.
- [List quizzes](https://docs.quiz-quail.com/api-reference/quizzes/list-quizzes.md): List all quizzes owned by the authenticated user with cursor-based pagination.
- [List rounds](https://docs.quiz-quail.com/api-reference/quizzes/list-rounds.md): List all rounds for a quiz, ordered by position.
- [Reorder questions](https://docs.quiz-quail.com/api-reference/quizzes/reorder-questions.md): Set the order of questions in a round by providing an ordered array of question IDs.
- [Reorder rounds](https://docs.quiz-quail.com/api-reference/quizzes/reorder-rounds.md): Set the order of rounds by providing an ordered array of round IDs.
- [Update a question](https://docs.quiz-quail.com/api-reference/quizzes/update-a-question.md)
- [Update a quiz](https://docs.quiz-quail.com/api-reference/quizzes/update-a-quiz.md): Update quiz properties. Only provided fields are updated.
- [Update a round](https://docs.quiz-quail.com/api-reference/quizzes/update-a-round.md)
- [Cancel a render job](https://docs.quiz-quail.com/api-reference/renders/cancel-a-render-job.md): Cancel an in-flight render job. Only pending, claimed, or rendering jobs can be cancelled.
- [Create a render job](https://docs.quiz-quail.com/api-reference/renders/create-a-render-job.md): Start rendering a quiz video. Returns 202 Accepted with a Location header for polling. Only one render per quiz can be in-flight at a time.
- [Get download URL](https://docs.quiz-quail.com/api-reference/renders/get-download-url.md): Get a signed download URL for a completed render. URL expires after 1 hour.
- [Get render status](https://docs.quiz-quail.com/api-reference/renders/get-render-status.md): Poll the status of a render job.
- [List render jobs](https://docs.quiz-quail.com/api-reference/renders/list-render-jobs.md): List render jobs with cursor pagination. Optionally filter by quiz ID or status.
- [Create a theme](https://docs.quiz-quail.com/api-reference/themes/create-a-theme.md): Create a new custom theme with colors, font, sound pack, and visual effects.
- [Delete a theme](https://docs.quiz-quail.com/api-reference/themes/delete-a-theme.md)
- [Get a theme](https://docs.quiz-quail.com/api-reference/themes/get-a-theme.md): Get a theme by ID. Users can access their own themes and public themes.
- [List themes](https://docs.quiz-quail.com/api-reference/themes/list-themes.md): List themes owned by the user plus optionally public themes. Cursor-paginated.
- [Update a theme](https://docs.quiz-quail.com/api-reference/themes/update-a-theme.md): Update theme properties. Only provided fields are updated. Users can only update their own themes.
- [Create a thumbnail](https://docs.quiz-quail.com/api-reference/thumbnails/create-a-thumbnail.md): Start a thumbnail render job for a quiz. Returns 202 Accepted. Only one thumbnail render per quiz can be in-flight.
- [Get trending topics](https://docs.quiz-quail.com/api-reference/trends/get-trending-topics.md): Get cached trending topics for quiz inspiration. Optionally filter by category. Results are refreshed by a background cron job.
- [Delete a webhook](https://docs.quiz-quail.com/api-reference/webhooks/delete-a-webhook.md): Delete a webhook and its delivery history.
- [List webhooks](https://docs.quiz-quail.com/api-reference/webhooks/list-webhooks.md): List all registered webhooks. Secrets are excluded from the response.
- [Register a webhook](https://docs.quiz-quail.com/api-reference/webhooks/register-a-webhook.md): Register a new webhook endpoint. The signing secret is returned only in the creation response — store it securely.
- [Test a webhook](https://docs.quiz-quail.com/api-reference/webhooks/test-a-webhook.md): Send a test event to a webhook to verify connectivity. Returns the delivery result.
- [Create an upload job](https://docs.quiz-quail.com/api-reference/youtube/create-an-upload-job.md): Upload a rendered quiz video to YouTube. Requires a completed render job and connected YouTube channel. Returns 202 Accepted.
- [Generate YouTube metadata](https://docs.quiz-quail.com/api-reference/youtube/generate-youtube-metadata.md): Use AI to generate an optimized title, description, and tags for a quiz video. Results are cached per quiz.
- [Get upload status](https://docs.quiz-quail.com/api-reference/youtube/get-upload-status.md): Poll the status of a YouTube upload job.
- [List uploads](https://docs.quiz-quail.com/api-reference/youtube/list-uploads.md): List YouTube upload jobs with cursor pagination. Optionally filter by quiz ID or status.
- [Authentication](https://docs.quiz-quail.com/authentication.md): Learn how to authenticate with the Quiz Quail API using API keys and scopes.
- [Errors](https://docs.quiz-quail.com/errors.md): Error response format, error types, and how to handle them.
- [AI Quiz Generation](https://docs.quiz-quail.com/guides/ai-generation.md): Generate quizzes with AI, discover trending topics, and get promotion suggestions
- [Media](https://docs.quiz-quail.com/guides/media.md): Upload, search, and manage images, audio, and video for your quizzes.
- [Quizzes](https://docs.quiz-quail.com/guides/quizzes.md): Create, manage, and structure quizzes with rounds and questions.
- [Video Rendering](https://docs.quiz-quail.com/guides/rendering.md): Render quiz videos asynchronously and download the output
- [Themes](https://docs.quiz-quail.com/guides/themes.md): Create and manage visual themes for your quiz videos.
- [YouTube Publishing](https://docs.quiz-quail.com/guides/youtube.md): Upload rendered videos to YouTube with AI-generated metadata
- [Introduction](https://docs.quiz-quail.com/introduction.md): Programmatically create quiz videos with the Quiz Quail API
- [Pagination](https://docs.quiz-quail.com/pagination.md): Navigate large result sets with cursor-based pagination.
- [Quickstart](https://docs.quiz-quail.com/quickstart.md): Go from zero to your first quiz video in under 5 minutes.
- [Rate Limiting](https://docs.quiz-quail.com/rate-limiting.md): Understand rate limit tiers, headers, and how to handle 429 responses.
- [Webhooks](https://docs.quiz-quail.com/webhooks.md): Receive real-time notifications when renders complete or YouTube uploads finish.

## OpenAPI Specs

- [openapi](https://docs.quiz-quail.com/api-reference/openapi.json)