POST /api/v1/quizzes/create
Create a Quiz
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.
Public endpoint
/api/v1/quizzes/create
Maps to
/api/sandbox/create_quiz
What to know first
The route is live today. The docs use the flat v1 contract language even though the service layer still normalizes into richer nested quiz attributes internally.
Method
POST
Send this operation to /api/v1/quizzes/create on the versioned public host.
Authentication
API key
API key via Authorization: Bearer or x-api-key
Resource model
Direct
The route is live today. The docs use the flat v1 contract language even though the service layer still normalizes into richer nested quiz attributes internally.
Highlights
What this operation does
Request details
Request parameters
Request parameters
These are the parameters that shape /api/v1/quizzes/create. Path parameters and request-body fields are shown together because the docs stay focused on the public route contract.
Optional title for the generated quiz resource.
Primary user request, learning goal, or topic for generation.
Optional raw source material to generate from when you want to bypass a separate upload step.
Quiz type selector. Common values include `multiple_choice`, `true_false`, and `open_ended`.
Default
multiple_choice
View supported values3 options
Return structured answer choices with one or more correct responses.
Return binary true/false questions with explanations.
Return free-response questions with answer guidance and scoring structure.
Optional reasoning lens selector. Exact accepted values come from the quiz service/validator layer.
View supported values10 options
Rebuild the idea from fundamental truths instead of pattern matching.
Derive conclusions from stated rules or premises.
Generalize from examples and observations.
Map structure from one situation onto another.
Reason about interactions across a larger system.
Consider downstream effects instead of the first visible outcome.
Work from the limiting factors and boundaries in the problem.
Update beliefs as new evidence arrives.
Solve by flipping the frame and asking what would make the opposite happen.
Evaluate tradeoffs and what each choice gives up.
Optional quiz difficulty steering. Use values accepted by the quiz validator layer.
Optional quiz length control such as micro, short, medium, long, or comprehensive.
View supported values5 options
Generate 3 questions for a very fast knowledge check.
Generate 5 questions for a compact assessment.
Generate 10 questions for balanced coverage.
Generate 15 questions for broader assessment depth.
Generate 25 questions for the heaviest quiz format.
Optional assessment intent such as formative, summative, diagnostic, or predictive.
View supported values4 options
Identify knowledge gaps and misconceptions.
Support learning while the learner is still building understanding.
Evaluate what the learner has mastered.
Estimate readiness for harder material or downstream performance.
Optional explanation depth selector.
View supported values3 options
Keep answer explanations to about one sentence.
Use a normal 2-3 sentence explanation depth.
Use a fuller 1-2 paragraph explanation style.
Optional question style / directness control.
View supported values4 options
Ask plainly without extra framing.
Wrap the question in a realistic situation or problem.
Use a larger case that requires careful reading first.
Force the learner through several reasoning moves before answering.
Optional control for how tightly the quiz should stay tied to source material.
View supported values5 options
Stay extremely close to the source material.
Reword the source while preserving the same meaning.
Test what is implied rather than explicitly stated.
Transfer source concepts into a new situation.
Combine ideas from multiple parts of the content.
Optional typed context objects. Use this field to send source text, documents, prior Vidbyte resources, or content you imported from a connected provider into the request.
View supported values9 options
Inline plain text you want the route to read directly.
A document payload or extracted document text normalized into the context layer.
A PDF payload or extracted PDF text normalized into the context layer.
A previously generated QuickHit identified by its encrypted public id.
A previously generated roadmap identified by its encrypted public id.
A previously generated quiz identified by its encrypted public id.
A previously generated exam identified by its encrypted public id.
A previously generated project identified by its encrypted public id.
An alias for project-backed context in the current middleware.
Response shape