video.quiz/api
Official30 toolsQuiz.Video MCP: list, create, AI-generate, and render quiz and flashcard videos.
Create, generate, and render AI-powered quiz and flashcard videos.
Captured live from the server via tools/list.
get_api_catalog
Return the Quiz.Video API catalog linkset for agent discovery.
No parameters.
get_openapi_spec
Return the Quiz.Video OpenAPI 3.1 specification.
No parameters.
get_llms_txt
Return a compact LLM-readable summary of the Quiz.Video API.
No parameters.
quiz_video_list_quizzes
List quizzes owned by the authenticated user with optional pagination (page, limit).
Parameters (2)
- pagenumber
1-indexed page number.
- limitnumber
Results per page (1–100, default 20).
quiz_video_get_quiz
Fetch a single quiz (including settings and metadata) by id.
Parameters (1)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
quiz_video_create_quiz
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[].
Parameters (12)
- titlestringrequired
Human-readable quiz title.
- descriptionstring
Optional longer description shown on the quiz page.
- formatstring
Output aspect ratio: "tiktok" (9:16 vertical) or "youtube" (16:9 horizontal).
- quizTypestring
Quiz mechanic: multiple_choice, reveal_answer, or picture_guess.
- templatestring
Visual template id (e.g. "neon", "minimal").
- countdownSecondsnumber
Seconds of countdown shown before each question (3–15).
- difficultystring
Target difficulty level for the generated/created quiz.
- backgroundMusicIdnumber | null
Background music track id from /api/v1/music. Omit to use the default YouTube-safe shared track; set null for silent.
- musicVolumenumber
Background music volume from 0 (silent) to 1 (full). Default 0.15.
- questionsarray
Optional initial questions with their answers and images.
- themeDescriptionstring
Natural-language custom visual theme prompt. Example: "golden luxury game show", "ocean glass", or "cyber neon". The server saves the generated themeCustomization and applies it automatically.
- themeCustomizationobject
Explicit custom theme to save and apply to the quiz. Invalid colors/fonts are ignored by the API sanitizer.
quiz_video_generate_quiz
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.
Parameters (15)
- topicstringrequired
Subject the AI should build the quiz around.
- extraDirectionstring
Additional instructions to steer the AI (tone, focus areas, exclusions).
- numberOfQuestionsnumber
How many questions to generate (1–200).
- answerOptionCountnumber
For multiple-choice quizzes, generate 3 or 4 answer options per question. Defaults to 4.
- difficultystring
Target difficulty level.
- quizTypestring
Quiz mechanic to generate.
- formatstring
Output aspect ratio. Defaults to "tiktok".
- templatestring
Visual template id. If omitted, the saved custom theme can suggest a matching template.
- countdownSecondsnumber
Seconds of countdown shown before each question (3-15).
- progressBarStylestring
Countdown progress indicator style.
- backgroundMusicIdnumber | null
Background music track id from /api/v1/music. Omit to use the default YouTube-safe shared track; set null for silent.
- musicVolumenumber
Background music volume from 0 (silent) to 1 (full). Default 0.15.
- themeDescriptionstring
Natural-language custom visual theme prompt. Example: "golden luxury game show", "ocean glass", or "cyber neon".
- themeCustomizationobject
Explicit custom theme to save and apply to the generated quiz. Use themeDescription for prompt-style themes.
- autoRenderboolean
If true, immediately queue a video render for the new quiz. The render session (sessionId, status) is returned under `data.render`; poll quiz_video_get_render with that sessionId for progress and the final videoUrl. Rendering typically takes 1-5 minutes. Quiz creation is not blocked by render-queue failures — the quiz is returned either way.
quiz_video_update_quiz
Update a quiz. `updates` accepts any subset of quiz settings (title, description, format, template, timing, music, TTS, publish status, etc.).
Parameters (2)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
- updatesobjectrequired
Partial quiz settings object; only included fields are updated.
quiz_video_delete_quiz
Permanently delete a quiz and all of its questions, answers, and hooks.
Parameters (1)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
quiz_video_list_quiz_questions
List questions (and their answers) for a quiz.
Parameters (1)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
quiz_video_add_quiz_questions
Append one or more questions (with their answers and optional images) to an existing quiz.
Parameters (2)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
- questionsarrayrequired
One or more questions to append to the quiz.
quiz_video_list_quiz_hooks
List video hooks configured for a quiz.
Parameters (1)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
quiz_video_create_quiz_hook
Create a hook for a quiz. `hook` is a pass-through object whose fields follow the HookInput schema (see OpenAPI spec).
Parameters (2)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
- hookobjectrequired
HookInput object (hookType, positionType, title, content, plus optional styling — see OpenAPI spec).
quiz_video_update_quiz_hook
Update an existing hook on a quiz. Requires quizId and numeric hookId; `updates` is a partial HookInput.
Parameters (3)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
- hookIdnumberrequired
Numeric id of the hook to update (from list_quiz_hooks).
- updatesobjectrequired
Partial HookInput object; only included fields are updated.
quiz_video_delete_quiz_hook
Delete a single hook from a quiz.
Parameters (2)
- quizIdstringrequired
Quiz ID in YouTube-style 11-character base64url format.
- hookIdnumberrequired
Numeric id of the hook to delete.
quiz_video_list_flashcard_decks
List flashcard decks owned by the authenticated user with optional pagination.
Parameters (2)
- pagenumber
1-indexed page number.
- limitnumber
Results per page (1–100, default 20).
quiz_video_get_flashcard_deck
Fetch a flashcard deck (including all cards) by id.
Parameters (1)
- deckIdstringrequired
Flashcard deck ID.
quiz_video_create_flashcard_deck
Create a flashcard deck. Required: title (3-120 chars) and cards[] (min 1). Optional: description (≤1200 chars), tags (≤50 each).
Parameters (4)
- titlestringrequired
Deck title (3–120 characters).
- descriptionstring
Optional deck description (≤1200 characters).
- tagsarray
Optional tags to categorize the deck (≤50 characters each).
- cardsarrayrequired
Flashcards in the deck; at least one card is required.
quiz_video_delete_flashcard_deck
Permanently delete a flashcard deck and all of its cards.
Parameters (1)
- deckIdstringrequired
Flashcard deck ID.
quiz_video_create_render
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.
Parameters (1)
- quizIdstringrequired
ID of the quiz to render into a video.
quiz_video_get_render
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.
Parameters (1)
- sessionIdstringrequired
Render session id returned when the render was started.
quiz_video_download_render
Request a signed download URL for a completed render.
Parameters (1)
- sessionIdstringrequired
Render session id for a completed render.
quiz_video_get_account
Get the authenticated user's account info, plan, and usage limits.
No parameters.
quiz_video_list_music
List available background music tracks.
No parameters.
quiz_video_list_templates
List the caller's saved custom templates (and optionally public ones). Templates are reusable scene-based designs that can be applied to many quizzes.
Parameters (3)
- includePublicboolean
Include public templates in addition to your own. Default true.
- pagenumber
- limitnumber
quiz_video_get_template
Fetch a single custom template (including the full scenes/layers payload) by id.
Parameters (1)
- templateIdstringrequired
Template id (tpl_...).
quiz_video_create_template
Save a new custom template authored in the drag-and-drop editor. Required: template (the CustomTemplate JSON). Optional: name, description, thumbnail, isDefault, isPublic.
Parameters (6)
- namestring
- descriptionstring
- thumbnailstring
Optional preview image URL or data URI.
- isDefaultboolean
Mark as your default template (replaces any existing default).
- isPublicboolean
Make discoverable to other users.
- templateobjectrequired
CustomTemplate JSON with scenes.hook/question/answer and canvas.
quiz_video_update_template
Update an existing template. Any subset of fields may be supplied; omitted fields stay unchanged.
Parameters (7)
- templateIdstringrequired
- namestring
- descriptionstring | null
- thumbnailstring | null
- isDefaultboolean
- isPublicboolean
- templateobject
quiz_video_delete_template
Permanently delete a custom template you own. Quizzes that have a snapshot of this template are unaffected — the snapshot remains in their themeCustomization.
Parameters (1)
- templateIdstringrequired
quiz_video_apply_template
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.
Parameters (2)
- templateIdstringrequired
- quizIdsarrayrequired
Quiz ids to apply the template to.
README not available yet.
Install
claude_desktop_config.json
{
"mcpServers": {
"api": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://www.quiz.video/mcp/"
]
}
}
}Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.