video.quiz/api

Return the Quiz.Video API catalog linkset for agent discovery.

Return a compact LLM-readable summary of the Quiz.Video API.

Return the Quiz.Video OpenAPI 3.1 specification.

Append one or more questions (with their answers and optional images) to an existing quiz.

Apply a snapshot of a custom template to one or more quizzes you own. Sets each quiz's template field to "custom" and writes the snapshot into themeCustomization.customTemplate. Future edits to the source template do not auto-propagate.

Create a flashcard deck. Required: title (3-120 chars) and cards[] (min 1). Optional: description (≤1200 chars), tags (≤50 each).

Create a quiz. Prefer sending themeDescription or themeCustomization so the saved quiz has a custom visual theme; if omitted, the server derives one from the title/description. Omit backgroundMusicId to use default YouTube-safe shared background music, or set null for silent. Required: title. Optional: description, format, quizType, template, countdownSeconds, difficulty, musicVolume, and questions[].

Create a hook for a quiz. `hook` is a pass-through object whose fields follow the HookInput schema (see OpenAPI spec).

Queue a new video render for an existing quiz. Returns the render sessionId; poll quiz_video_get_render until its status is "completed" (typically 1-5 minutes), then call quiz_video_download_render to obtain the signed MP4 URL. The quiz itself is viewable immediately at /quiz/{slug}/ regardless of render status.

Save a new custom template authored in the drag-and-drop editor. Required: template (the CustomTemplate JSON). Optional: name, description, thumbnail, isDefault, isPublic.

Permanently delete a flashcard deck and all of its cards.

Permanently delete a quiz and all of its questions, answers, and hooks.

Delete a single hook from a quiz.

Permanently delete a custom template you own. Quizzes that have a snapshot of this template are unaffected — the snapshot remains in their themeCustomization.

Request a signed download URL for a completed render.

AI-generate and save a quiz from a topic. Prefer providing themeDescription or themeCustomization; when omitted, the server derives and saves a topic-based custom theme. Omit backgroundMusicId to use default YouTube-safe shared background music, or set null for silent. The response `data` always includes a `watchUrl` (the public quiz-viewer page, instantly playable). When autoRender is true, `data.render` also contains the queued render session so the agent can poll quiz_video_get_render for the MP4.

Get the authenticated user's account info, plan, and usage limits.

Fetch a flashcard deck (including all cards) by id.

Fetch a single quiz (including settings and metadata) by id.

Fetch the status and progress of a render session. When status is "completed", the response also contains a signed `videoUrl` (and `filename`) so the agent can share the MP4 directly without a separate quiz_video_download_render call. In-progress polls return status + progress.

Fetch a single custom template (including the full scenes/layers payload) by id.

List flashcard decks owned by the authenticated user with optional pagination.

List available background music tracks.

List video hooks configured for a quiz.

List questions (and their answers) for a quiz.

List quizzes owned by the authenticated user with optional pagination (page, limit).

List the caller's saved custom templates (and optionally public ones). Templates are reusable scene-based designs that can be applied to many quizzes.

Update a quiz. `updates` accepts any subset of quiz settings (title, description, format, template, timing, music, TTS, publish status, etc.).

Update an existing hook on a quiz. Requires quizId and numeric hookId; `updates` is a partial HookInput.

Update an existing template. Any subset of fields may be supplied; omitted fields stay unchanged.