Quizzes API
The Quizzes API covers the full quiz lifecycle: create a quiz, batch-generate multiple quizzes, list and fetch saved quizzes, and progressively update an existing quiz by semantic action groups.
Think about quiz generation in two layers
For most callers, the public v1 mental model should stay flat: prompt, content, quiz type, context, and a handful of top-level steering knobs.
For power users, Vidbyte's quiz engine also has a richer internal attribute system covering question design, content relationship, answer-choice architecture, and quiz info. The public route normalizes into those structures behind the scenes.
The family supports generation, retrieval, and progressive refinement
Use `/create` for a single quiz.
Use `/batch-create` when you need multiple variants in one request envelope.
Use `/list` and `/get` for saved quiz retrieval.
Use `/update` when the product needs to make an existing quiz harder, longer, or more focused without starting over.
Keep the first integration focused on a few clear steering knobs
Quiz type
Pick the question form you actually need first, such as multiple choice, true/false, or open ended.
Difficulty and length
Use a small number of clear difficulty and length signals instead of layering every possible preference at once.
Reasoning and focus
Add reasoning lens or content focus only when the product needs sharper control over what the quiz is testing.
Endpoints
/create
/api/v1/quizzes/create
Create a new quiz with the public v1 request contract. This page covers the request fields, the supported steering values, and the exact response you can parse in production.
/batch-create
/api/v1/quizzes/batch_create
Generate multiple quizzes in one request envelope. This route is designed for scenarios where you need several quiz variants or per-learner quiz generation in one call.
/get
/api/v1/quizzes/get/{encrypted_id}
Fetch one previously generated quiz by encrypted public id. Use this after your application has persisted the id returned from create, batch create, or list.
/list
/api/v1/quizzes/list
List the quizzes owned by the authenticated principal. This route is useful for history views, audit trails, and state reconciliation in client applications.
/update
/api/v1/quizzes/update
Progressively update an existing quiz by semantic action groups instead of rebuilding it from scratch. This route is useful when your product supports iterative quiz refinement.