Preview / internal onlyReference

Live sandbox generation exists, but a public API-key route layer is still pending

Quizzes API

Quiz generation and progressive editing already exist in the backend under sandbox routes. The product design points toward cleaner versioned quiz endpoints, but those resource-style paths are not shipped yet for external API-key callers.

Manage keys
Route-accurate reference

Current live backend

/api/sandbox/create_quiz

Internal app-auth route.

Editing flow

/api/sandbox/edit_quiz

Internal progressive quiz updates already exist.

Planned public shape

/api/v1/quizzes

Design direction, not live route reality yet.

How to read this page

Treat sandbox routes as implementation context and the `/api/v1/quizzes` shape as roadmap direction.

Do not build external integrations against the preview versioned route until the backend policy surface exposes it.

Routes

What this page actually points to

3 entries
POSTInternal only

/api/sandbox/create_quiz

Generate a quiz from content using sandbox orchestration.

Auth

Session/JWT auth in the app today

Notes

This route is live in the backend but is not yet approved by `is_api_key_route` for external API-key access.

POSTInternal only

/api/sandbox/edit_quiz

Apply progressive edits to an existing quiz.

Auth

Session/JWT auth in the app today

Notes

Current app route, not a public API-key route.

POSTPreview

/api/v1/quizzes

Planned versioned quiz create route described by the product design.

Auth

Planned API key support

Notes

This shape is design direction, not a shipped backend path.

Request details

Planned top-level quiz fields

Useful for planning, but still preview for external API-key callers.

question_typesstring | string[]Required

Multiple choice, true/false, or open-ended.

quiz_settingsobjectOptional

Preset-first configuration layer for question design and quiz info.

promptstringRequired

Learning goal or assessment target.

contextobject[]Optional

Shared context envelope as it becomes public.

Related pages

Preview / internal only

Exams

The backend can already generate exams through `/api/sandbox/create_test`, but the cleaner `/api/v1/exams` contract described by the product design remains preview-only.

Open page
Preview / internal only

Projects

Project Studio already has backend generation primitives, but the public API-key surface does not yet expose a clean versioned project create route. The docs therefore show the current internal routes and the planned public direction separately.

Open page
Preview contract

Context Objects

The product design describes a shared `context` array for learner data, source documents, and Vidbyte artifacts. That envelope is already present in some request models, but the current public routes still primarily map prompt-driven fields into the existing internal orchestrators.

Open page