api
Quiz.Video MCP: list, create, AI-generate, and render quiz and flashcard videos.
Sollte ich dies verwenden
Qualität und Sicherheit
Befunde (5)
- LOWin quiz_video_add_quiz_questions
- LOWin quiz_video_list_flashcard_decks
- LOWin quiz_video_create_flashcard_deck
- LOWin quiz_video_delete_flashcard_deck
- LOWin quiz_video_complete_media_upload
Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.
Kontextkosten
Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.
Installieren
Installation mit einem Klick
Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:
{
"mcpServers": {
"api": {
"url": "https://www.quiz.video/mcp/"
}
}
}Remote-Endpunkte
https://www.quiz.video/mcp/streamable-httpWas es kann
Tool-Inventar
Tools (39)
🟢get_api_catalog
Return the Quiz.Video API catalog linkset for agent discovery.
Eingabe-Schema
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢get_openapi_spec
Return the Quiz.Video OpenAPI 3.1 specification.
Eingabe-Schema
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢get_llms_txt
Return a compact LLM-readable summary of the Quiz.Video API.
Eingabe-Schema
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢get_api_index
Return the GET /api/v1 index: documentation and OpenAPI URLs, OAuth/API-key auth metadata, rate-limit and versioning policy, and every resource URL.
Eingabe-Schema
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢quiz_video_list_quizzes(page, limit)
List quizzes owned by the authenticated user with optional pagination (page, limit).
Eingabe-Schema
{
"type": "object",
"properties": {
"page": {
"type": "number",
"minimum": 1,
"description": "1-indexed page number."
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 100,
"description": "Results per page (1–100, default 20)."
}
},
"additionalProperties": false
}🟢quiz_video_get_quiz(quizId)
Fetch a single quiz (including settings and metadata) by id.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
}
},
"required": [
"quizId"
],
"additionalProperties": false
}🟡quiz_video_create_quiz(title, description, videoLanguage, format, quizType, ...)
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[].
Eingabe-Schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"description": "Human-readable quiz title."
},
"description": {
"type": "string",
"description": "Optional longer description shown on the quiz page."
},
"videoLanguage": {
"type": "string",
"description": "Language the quiz is written in, e.g. \"es\" or \"ar\". Sets narration and the language and text direction of the play page. Defaults to en-US."
},
"format": {
"type": "string",
"enum": [
"tiktok",
"youtube"
],
"description": "Output aspect ratio: \"tiktok\" (9:16 vertical) or \"youtube\" (16:9 horizontal)."
},
"quizType": {
"type": "string",
"enum": [
"multiple_choice",
"reveal_answer",
"picture_guess"
],
"description": "Quiz mechanic: multiple_choice, reveal_answer, or picture_guess."
},
"template": {
"type": "string",
"description": "Visual template id (e.g. \"neon\", \"minimal\")."
},
"countdownSeconds": {
"type": "number",
"minimum": 3,
"maximum": 15,
"description": "Seconds of countdown shown before each question (3–15)."
},
"difficulty": {
"type": "string",
"enum": [
"easy",
"medium",
"hard",
"rising"
],
"description": "Target difficulty level for the generated/created quiz."
},
"backgroundMusicId": {
"type": [
"number",
"null"
],
"description": "Background music track id from /api/v1/music. Omit to use the default YouTube-safe shared track; set null for silent."
},
"musicVolume": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Background music volume from 0 (silent) to 1 (full). Default 0.15."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"questionText": {
"type": "string",
"minLength": 1,
"description": "The question prompt shown to viewers."
},
"ttsText": {
"type": "string",
"description": "Optional exact narration line for this question."
},
"imagePath": {
"type": "string",
"description": "Optional primary image URL shown with the question (used by picture_guess quizzes)."
},
"order": {
"type": "number",
"description": "1-indexed display order of the question within the quiz."
},
"duration": {
"type": "number",
"minimum": 1,
"description": "Seconds viewers have to answer this question (must be >= 1)."
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answerText": {
"type": "string",
"minLength": 1,
"description": "Answer text shown to viewers."
},
"isCorrect": {
"type": "boolean",
"description": "Whether this answer is the correct one for the question."
},
"order": {
"type": "number",
"description": "1-indexed display order of the answer within the question."
},
"additionalInfo": {
"type": "string",
"description": "Optional explanation or trivia shown after the answer is revealed."
},
"ttsText": {
"type": "string",
"description": "Optional exact narration line for the answer reveal."
}
},
"required": [
"answerText",
"isCorrect"
],
"additionalProperties": false
},
"description": "Answer options for this question; exactly one should be marked isCorrect=true."
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Absolute URL of the image asset."
},
"alt": {
"type": "string",
"description": "Alt text describing the image for accessibility."
},
"source": {
"type": "string",
"description": "Image source label, e.g. \"upload\", \"unsplash\", \"generated\"."
},
"sourceUrl": {
"type": "string",
"description": "Original attribution URL for the image, if any."
},
"width": {
"type": "number",
"description": "Image width in pixels."
},
"height": {
"type": "number",
"description": "Image height in pixels."
}
},
"required": [
"url"
],
"additionalProperties": true
},
"description": "Additional images attached to the question (in addition to imagePath)."
}
},
"required": [
"questionText"
],
"additionalProperties": true
},
"description": "Optional initial questions with their answers and images."
},
"themeDescription": {
"type": "string",
"description": "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."
},
"themeCustomization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Optional saved theme label, e.g. \"Golden Theme\"."
},
"description": {
"type": "string",
"description": "Optional natural-language source description for the custom theme."
},
"accentColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Primary accent hex color, e.g. \"#F6C945\"."
},
"secondaryColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Secondary accent hex color."
},
"backgroundColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Solid background hex color."
},
"textColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Hex color of question and on-screen text."
},
"answerTextColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Hex color of answer text."
},
"fontFamilyOverride": {
"type": "string",
"enum": [
"Inter",
"Poppins",
"Roboto",
"Montserrat",
"Open Sans",
"Lato",
"Raleway",
"Source Sans 3",
"Space Grotesk",
"Manrope",
"Work Sans",
"DM Sans",
"Lexend",
"Nunito",
"Quicksand",
"Outfit",
"Sora",
"Albert Sans",
"Bricolage Grotesque",
"Playfair Display",
"Merriweather",
"Cormorant Garamond",
"Fraunces",
"Crimson Pro",
"Cinzel",
"Oswald",
"Bebas Neue",
"Anton",
"Archivo Black",
"Big Shoulders",
"Bungee",
"Bangers",
"Lilita One",
"Fredoka",
"Baloo 2",
"Exo 2",
"Orbitron",
"Press Start 2P",
"Caveat",
"Dancing Script",
"Pacifico",
"Permanent Marker",
"Noto Sans",
"Noto Naskh Arabic",
"Vazirmatn"
],
"description": "Font for all video text. A font without letters for the quiz language falls back to that language's own font for those letters."
},
"styleControls": {
"type": "boolean",
"description": "Set automatically by the API when an override is sent. Makes overrides reach every scene and custom templates, not just preset question and answer slides."
}
},
"additionalProperties": false,
"description": "Explicit custom theme to save and apply to the quiz. Invalid colors/fonts are ignored by the API sanitizer."
}
},
"required": [
"title"
],
"additionalProperties": true
}🟡quiz_video_generate_quiz(topic, language, extraDirection, numberOfQuestions, answerOptionCount, ...)
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` includes `visibility`, `playable` and `playUrl` (where people take the quiz in a browser) when the quiz is shareable, plus `watchUrl` when it is public. If `playable` is false, call quiz_video_share_quiz to get a link. When autoRender is true, `data.render` also contains the queued render session so the agent can poll quiz_video_get_render for the MP4.
Eingabe-Schema
{
"type": "object",
"properties": {
"topic": {
"type": "string",
"minLength": 1,
"maxLength": 20000,
"description": "Subject the AI should build the quiz around. Can be a short topic or a detailed multi-paragraph brief (up to 20,000 characters)."
},
"language": {
"type": "string",
"maxLength": 20,
"description": "Language to write the quiz in, e.g. \"es\" or \"ar\". Optional: without it the quiz follows the language of the topic, or English if that is unclear."
},
"extraDirection": {
"type": "string",
"maxLength": 20000,
"description": "Additional instructions to steer the AI (tone, focus areas, exclusions). Up to 20,000 characters."
},
"numberOfQuestions": {
"type": "number",
"minimum": 1,
"maximum": 200,
"description": "How many questions to generate (1–200)."
},
"answerOptionCount": {
"type": "number",
"enum": [
3,
4
],
"description": "For multiple-choice quizzes, generate 3 or 4 answer options per question. Defaults to 4."
},
"difficulty": {
"type": "string",
"enum": [
"easy",
"medium",
"hard",
"rising"
],
"description": "Target difficulty level."
},
"quizType": {
"type": "string",
"enum": [
"multiple_choice",
"reveal_answer",
"picture_guess"
],
"description": "Quiz mechanic to generate."
},
"format": {
"type": "string",
"enum": [
"tiktok",
"youtube"
],
"description": "Output aspect ratio. Defaults to \"tiktok\"."
},
"template": {
"type": "string",
"description": "Visual template id. If omitted, the saved custom theme can suggest a matching template."
},
"countdownSeconds": {
"type": "number",
"minimum": 3,
"maximum": 15,
"description": "Seconds of countdown shown before each question (3-15)."
},
"progressBarStyle": {
"type": "string",
"enum": [
"circle",
"line"
],
"description": "Countdown progress indicator style."
},
"backgroundMusicId": {
"type": [
"number",
"null"
],
"description": "Background music track id from /api/v1/music. Omit to use the default YouTube-safe shared track; set null for silent."
},
"musicVolume": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Background music volume from 0 (silent) to 1 (full). Default 0.15."
},
"themeDescription": {
"type": "string",
"maxLength": 20000,
"description": "Natural-language custom visual theme prompt. Example: \"golden luxury game show\", \"ocean glass\", or \"cyber neon\"."
},
"themeCustomization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Optional saved theme label, e.g. \"Golden Theme\"."
},
"description": {
"type": "string",
"description": "Optional natural-language source description for the custom theme."
},
"accentColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Primary accent hex color, e.g. \"#F6C945\"."
},
"secondaryColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Secondary accent hex color."
},
"backgroundColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Solid background hex color."
},
"textColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Hex color of question and on-screen text."
},
"answerTextColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Hex color of answer text."
},
"fontFamilyOverride": {
"type": "string",
"enum": [
"Inter",
"Poppins",
"Roboto",
"Montserrat",
"Open Sans",
"Lato",
"Raleway",
"Source Sans 3",
"Space Grotesk",
"Manrope",
"Work Sans",
"DM Sans",
"Lexend",
"Nunito",
"Quicksand",
"Outfit",
"Sora",
"Albert Sans",
"Bricolage Grotesque",
"Playfair Display",
"Merriweather",
"Cormorant Garamond",
"Fraunces",
"Crimson Pro",
"Cinzel",
"Oswald",
"Bebas Neue",
"Anton",
"Archivo Black",
"Big Shoulders",
"Bungee",
"Bangers",
"Lilita One",
"Fredoka",
"Baloo 2",
"Exo 2",
"Orbitron",
"Press Start 2P",
"Caveat",
"Dancing Script",
"Pacifico",
"Permanent Marker",
"Noto Sans",
"Noto Naskh Arabic",
"Vazirmatn"
],
"description": "Font for all video text. A font without letters for the quiz language falls back to that language's own font for those letters."
},
"styleControls": {
"type": "boolean",
"description": "Set automatically by the API when an override is sent. Makes overrides reach every scene and custom templates, not just preset question and answer slides."
}
},
"additionalProperties": false,
"description": "Explicit custom theme to save and apply to the generated quiz. Use themeDescription for prompt-style themes."
},
"autoRender": {
"type": "boolean",
"description": "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."
}
},
"required": [
"topic"
],
"additionalProperties": false
}🟡quiz_video_update_quiz(quizId, updates)
Update a quiz. `updates` accepts any subset of quiz settings (title, description, format, template, timing, music, TTS, publish status, etc.).
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
},
"updates": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Updated quiz title."
},
"description": {
"type": "string",
"description": "Updated quiz description."
},
"format": {
"type": "string",
"enum": [
"tiktok",
"youtube"
],
"description": "Output aspect ratio: \"tiktok\" (9:16 vertical) or \"youtube\" (16:9 horizontal)."
},
"countdownSeconds": {
"type": "number",
"minimum": 3,
"maximum": 15,
"description": "Seconds of countdown shown before each question (3–15)."
},
"quizType": {
"type": "string",
"enum": [
"multiple_choice",
"reveal_answer",
"picture_guess"
],
"description": "Quiz mechanic: multiple_choice, reveal_answer, or picture_guess."
},
"template": {
"type": "string",
"description": "Visual template id (e.g. \"neon\", \"minimal\"). See /api/v1 templates list."
},
"progressBarStyle": {
"type": "string",
"enum": [
"circle",
"line"
],
"description": "Countdown progress indicator style."
},
"backgroundMusicId": {
"type": [
"number",
"null"
],
"description": "Background music track id from /api/v1/music. Omit to use the default YouTube-safe shared track; set null for silent."
},
"musicVolume": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Background music volume from 0 (silent) to 1 (full). Default 0.15."
},
"showQuestionCount": {
"type": "boolean",
"description": "Whether to show the \"Question N of M\" indicator."
},
"revealStyle": {
"type": "string",
"description": "Animation style used when revealing the correct answer."
},
"questionFontSize": {
"type": "integer",
"minimum": 72,
"maximum": 204,
"description": "Question text size. 120 is the template default: 180 asks for 150%. Text never clips, so it stops growing once it fills its space. Applies to built-in and custom templates."
},
"answerFontSize": {
"type": "integer",
"minimum": 58,
"maximum": 163,
"description": "Answer text size. 96 is the template default. Text never clips, so it stops growing once it fills its space. Applies to built-in and custom templates."
},
"enableTTS": {
"type": "boolean",
"description": "Whether to read questions and answers aloud via text-to-speech."
},
"ttsVoice": {
"type": "string",
"description": "Text-to-speech voice identifier."
},
"ttsSpeed": {
"type": "number",
"minimum": 0.5,
"maximum": 1.5,
"description": "Text-to-speech playback speed multiplier."
},
"ttsQuestionTemplate": {
"type": "string",
"description": "Template string used to phrase the question for TTS."
},
"ttsAnswerTemplate": {
"type": "string",
"description": "Template string used to phrase the answer for TTS."
},
"paceMultiplier": {
"type": "number",
"minimum": 0.3,
"maximum": 1.6,
"description": "Global timing multiplier applied to durations and animations."
},
"isPublished": {
"type": "boolean",
"description": "Whether the quiz is publicly listed on quiz.video. Setting this also ends \"anyone with the link\" access; use quiz_video_share_quiz to choose between private, unlisted and public."
},
"themeDescription": {
"type": "string",
"description": "Natural-language custom visual theme prompt. Example: \"golden luxury game show\". The server saves the generated themeCustomization and applies it automatically."
},
"themeCustomization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Optional saved theme label, e.g. \"Golden Theme\"."
},
"description": {
"type": "string",
"description": "Optional natural-language source description for the custom theme."
},
"accentColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Primary accent hex color, e.g. \"#F6C945\"."
},
"secondaryColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Secondary accent hex color."
},
"backgroundColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Solid background hex color."
},
"textColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Hex color of question and on-screen text."
},
"answerTextColorOverride": {
"type": "string",
"pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
"description": "Hex color of answer text."
},
"fontFamilyOverride": {
"type": "string",
"enum": [
"Inter",
"Poppins",
"Roboto",
"Montserrat",
"Open Sans",
"Lato",
"Raleway",
"Source Sans 3",
"Space Grotesk",
"Manrope",
"Work Sans",
"DM Sans",
"Lexend",
"Nunito",
"Quicksand",
"Outfit",
"Sora",
"Albert Sans",
"Bricolage Grotesque",
"Playfair Display",
"Merriweather",
"Cormorant Garamond",
"Fraunces",
"Crimson Pro",
"Cinzel",
"Oswald",
"Bebas Neue",
"Anton",
"Archivo Black",
"Big Shoulders",
"Bungee",
"Bangers",
"Lilita One",
"Fredoka",
"Baloo 2",
"Exo 2",
"Orbitron",
"Press Start 2P",
"Caveat",
"Dancing Script",
"Pacifico",
"Permanent Marker",
"Noto Sans",
"Noto Naskh Arabic",
"Vazirmatn"
],
"description": "Font for all video text. A font without letters for the quiz language falls back to that language's own font for those letters."
},
"styleControls": {
"type": "boolean",
"description": "Set automatically by the API when an override is sent. Makes overrides reach every scene and custom templates, not just preset question and answer slides."
}
},
"additionalProperties": false,
"description": "Explicit custom theme to save on the quiz. Use this when you already know the exact colors/font."
}
},
"additionalProperties": true,
"description": "Partial quiz settings object; only included fields are updated."
}
},
"required": [
"quizId",
"updates"
],
"additionalProperties": false
}🔴quiz_video_delete_quiz(quizId)
Permanently delete a quiz and all of its questions, answers, and hooks.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
}
},
"required": [
"quizId"
],
"additionalProperties": false
}🟢quiz_video_list_quiz_questions(quizId)
List questions (and their answers) for a quiz.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
}
},
"required": [
"quizId"
],
"additionalProperties": false
}🟡quiz_video_add_quiz_questions(quizId, questions)
Append one or more questions (with their answers and optional images) to an existing quiz.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
},
"questions": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"questionText": {
"type": "string",
"minLength": 1,
"description": "The question prompt shown to viewers."
},
"ttsText": {
"type": "string",
"description": "Optional exact narration line for this question."
},
"imagePath": {
"type": "string",
"description": "Optional primary image URL shown with the question (used by picture_guess quizzes)."
},
"order": {
"type": "number",
"description": "1-indexed display order of the question within the quiz."
},
"duration": {
"type": "number",
"minimum": 1,
"description": "Seconds viewers have to answer this question (must be >= 1)."
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answerText": {
"type": "string",
"minLength": 1,
"description": "Answer text shown to viewers."
},
"isCorrect": {
"type": "boolean",
"description": "Whether this answer is the correct one for the question."
},
"order": {
"type": "number",
"description": "1-indexed display order of the answer within the question."
},
"additionalInfo": {
"type": "string",
"description": "Optional explanation or trivia shown after the answer is revealed."
},
"ttsText": {
"type": "string",
"description": "Optional exact narration line for the answer reveal."
}
},
"required": [
"answerText",
"isCorrect"
],
"additionalProperties": false
},
"description": "Answer options for this question; exactly one should be marked isCorrect=true."
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Absolute URL of the image asset."
},
"alt": {
"type": "string",
"description": "Alt text describing the image for accessibility."
},
"source": {
"type": "string",
"description": "Image source label, e.g. \"upload\", \"unsplash\", \"generated\"."
},
"sourceUrl": {
"type": "string",
"description": "Original attribution URL for the image, if any."
},
"width": {
"type": "number",
"description": "Image width in pixels."
},
"height": {
"type": "number",
"description": "Image height in pixels."
}
},
"required": [
"url"
],
"additionalProperties": true
},
"description": "Additional images attached to the question (in addition to imagePath)."
}
},
"required": [
"questionText"
],
"additionalProperties": true
},
"description": "One or more questions to append to the quiz."
}
},
"required": [
"quizId",
"questions"
],
"additionalProperties": false
}🟢quiz_video_list_quiz_hooks(quizId)
List video hooks configured for a quiz.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
}
},
"required": [
"quizId"
],
"additionalProperties": false
}🟡quiz_video_create_quiz_hook(quizId, hook)
Create a hook for a quiz. `hook` is a pass-through object whose fields follow the HookInput schema (see OpenAPI spec).
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
},
"hook": {
"type": "object",
"additionalProperties": true,
"properties": {},
"description": "HookInput object (hookType, positionType, title, content, plus optional styling — see OpenAPI spec)."
}
},
"required": [
"quizId",
"hook"
],
"additionalProperties": false
}🟡quiz_video_update_quiz_hook(quizId, hookId, updates)
Update an existing hook on a quiz. Requires quizId and numeric hookId; `updates` is a partial HookInput.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
},
"hookId": {
"type": "number",
"description": "Numeric id of the hook to update (from list_quiz_hooks)."
},
"updates": {
"type": "object",
"additionalProperties": true,
"properties": {},
"description": "Partial HookInput object; only included fields are updated."
}
},
"required": [
"quizId",
"hookId",
"updates"
],
"additionalProperties": false
}🔴quiz_video_delete_quiz_hook(quizId, hookId)
Delete a single hook from a quiz.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "Quiz ID in YouTube-style 11-character base64url format."
},
"hookId": {
"type": "number",
"description": "Numeric id of the hook to delete."
}
},
"required": [
"quizId",
"hookId"
],
"additionalProperties": false
}🟢quiz_video_list_flashcard_decks(page, limit)
List flashcard decks owned by the authenticated user with optional pagination.
Eingabe-Schema
{
"type": "object",
"properties": {
"page": {
"type": "number",
"minimum": 1,
"description": "1-indexed page number."
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 100,
"description": "Results per page (1–100, default 20)."
}
},
"additionalProperties": false
}🟢quiz_video_get_flashcard_deck(deckId)
Fetch a flashcard deck (including all cards) by id.
Eingabe-Schema
{
"type": "object",
"properties": {
"deckId": {
"type": "string",
"minLength": 1,
"description": "Flashcard deck ID."
}
},
"required": [
"deckId"
],
"additionalProperties": false
}🟡quiz_video_create_flashcard_deck(title, description, tags, cards)
Create a flashcard deck. Required: title (3-120 chars) and cards[] (min 1). Optional: description (≤1200 chars), tags (≤50 each).
Eingabe-Schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 3,
"maxLength": 120,
"description": "Deck title (3–120 characters)."
},
"description": {
"type": "string",
"maxLength": 1200,
"description": "Optional deck description (≤1200 characters)."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 50
},
"description": "Optional tags to categorize the deck (≤50 characters each)."
},
"cards": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"front": {
"type": "string",
"minLength": 1,
"description": "Text shown on the front of the flashcard (the prompt)."
},
"back": {
"type": "string",
"minLength": 1,
"description": "Text shown on the back of the flashcard (the answer)."
},
"hint": {
"type": "string",
"description": "Optional hint shown before revealing the back of the card."
},
"order": {
"type": "number",
"description": "1-indexed display order of the card within the deck."
}
},
"required": [
"front",
"back"
],
"additionalProperties": false
},
"description": "Flashcards in the deck; at least one card is required."
}
},
"required": [
"title",
"cards"
],
"additionalProperties": false
}🔴quiz_video_delete_flashcard_deck(deckId)
Permanently delete a flashcard deck and all of its cards.
Eingabe-Schema
{
"type": "object",
"properties": {
"deckId": {
"type": "string",
"minLength": 1,
"description": "Flashcard deck ID."
}
},
"required": [
"deckId"
],
"additionalProperties": false
}🟡quiz_video_create_render(quizId)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1,
"description": "ID of the quiz to render into a video."
}
},
"required": [
"quizId"
],
"additionalProperties": false
}🟢quiz_video_get_render(sessionId)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"minLength": 1,
"description": "Render session id returned when the render was started."
}
},
"required": [
"sessionId"
],
"additionalProperties": false
}🟢quiz_video_download_render(sessionId)
Request a signed download URL for a completed render.
Eingabe-Schema
{
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"minLength": 1,
"description": "Render session id for a completed render."
}
},
"required": [
"sessionId"
],
"additionalProperties": false
}🟢quiz_video_get_account
Get the authenticated user's account info, plan, and usage limits.
Eingabe-Schema
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢quiz_video_list_music
List available background music tracks.
Eingabe-Schema
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢quiz_video_list_templates(includePublic, 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.
Eingabe-Schema
{
"type": "object",
"properties": {
"includePublic": {
"type": "boolean",
"description": "Include public templates in addition to your own. Default true."
},
"page": {
"type": "number",
"minimum": 1
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}🟢quiz_video_get_template(templateId)
Fetch a single custom template (including the full scenes/layers payload) by id.
Eingabe-Schema
{
"type": "object",
"properties": {
"templateId": {
"type": "string",
"minLength": 1,
"description": "Template id (tpl_...)."
}
},
"required": [
"templateId"
],
"additionalProperties": false
}🔴quiz_video_create_template(name, description, thumbnail, isDefault, isPublic, ...)
Save a new custom template authored in the drag-and-drop editor. Required: template (the CustomTemplate JSON). Optional: name, description, thumbnail, isDefault, isPublic.
Eingabe-Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"description": {
"type": "string",
"maxLength": 280
},
"thumbnail": {
"type": "string",
"description": "Optional preview image URL or data URI."
},
"isDefault": {
"type": "boolean",
"description": "Mark as your default template (replaces any existing default)."
},
"isPublic": {
"type": "boolean",
"description": "Make discoverable to other users."
},
"template": {
"type": "object",
"description": "CustomTemplate JSON with scenes.hook/question/answer and canvas."
}
},
"required": [
"template"
],
"additionalProperties": false
}🟡quiz_video_update_template(templateId, name, description, thumbnail, isDefault, ...)
Update an existing template. Any subset of fields may be supplied; omitted fields stay unchanged.
Eingabe-Schema
{
"type": "object",
"properties": {
"templateId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 280
},
"thumbnail": {
"type": [
"string",
"null"
]
},
"isDefault": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"template": {
"type": "object"
}
},
"required": [
"templateId"
],
"additionalProperties": false
}🔴quiz_video_delete_template(templateId)
Permanently delete a custom template you own. Quizzes that have a snapshot of this template are unaffected — the snapshot remains in their themeCustomization.
Eingabe-Schema
{
"type": "object",
"properties": {
"templateId": {
"type": "string",
"minLength": 1
}
},
"required": [
"templateId"
],
"additionalProperties": false
}🟡quiz_video_share_quiz(quizId, visibility)
Get a URL where people take a quiz in their browser with no sign-in, and set who can open it. `unlisted` (the default) works for anyone with the link and is never listed or indexed; `public` also lists it in the quiz library and search engines; `private` turns the link off. Returns visibility, playUrl, quizUrl (public quizzes only) and embedHtml. Fails if the quiz has no questions with answers yet.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1
},
"visibility": {
"type": "string",
"enum": [
"private",
"unlisted",
"public"
],
"default": "unlisted",
"description": "Who can open the quiz."
}
},
"required": [
"quizId"
],
"additionalProperties": false
}🟢quiz_video_get_quiz_results(quizId)
See how people did on a quiz you own: plays, completions, average score, and the hardest questions. Results are aggregated and hold no personal data. Scores are computed from answers submitted by the browser, so treat them as engagement data, not exam records.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1
}
},
"required": [
"quizId"
],
"additionalProperties": false
}🟡quiz_video_create_media_upload(filename, contentType, size, kind, purpose)
Get a presigned URL to upload your own image, video or audio file. PUT the file bytes to uploadUrl with the returned headers (Content-Type must match and the body must be exactly `size` bytes), then call quiz_video_complete_media_upload. Files go to Quiz.Video storage; quizzes can only use uploaded files, never outside URLs. Limits: images 15 MB, videos 250 MB and 5 minutes, audio 50 MB. Use purpose "music" to add a background track, which returns a musicId to set as backgroundMusicId.
Eingabe-Schema
{
"type": "object",
"properties": {
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "File name including extension, e.g. \"clip.mp4\"."
},
"contentType": {
"type": "string",
"description": "MIME type, e.g. \"video/mp4\"."
},
"size": {
"type": "number",
"minimum": 1,
"description": "Exact file size in bytes."
},
"kind": {
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
"purpose": {
"type": "string",
"enum": [
"library",
"music"
],
"default": "library"
}
},
"required": [
"filename",
"size"
],
"additionalProperties": false
}🟡quiz_video_complete_media_upload(assetId, durationSeconds, name)
Call after the PUT succeeds. The server reads the stored file and checks it really is what it claims. A damaged or wrong file is deleted and the response explains why. Returns the asset; use asset.id in quiz_video_update_quiz_media.
Eingabe-Schema
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"durationSeconds": {
"type": "number",
"exclusiveMinimum": 0,
"description": "Optional: only used if the file does not state its own length."
},
"name": {
"type": "string",
"maxLength": 120,
"description": "Display name for a music track."
}
},
"required": [
"assetId"
],
"additionalProperties": false
}🟢quiz_video_list_media(kind, limit)
List files you have uploaded, newest first, so a file can be re-used without uploading it again. URLs in the response are signed and expire within an hour.
Eingabe-Schema
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"image",
"video",
"audio"
]
},
"limit": {
"type": "number",
"minimum": 1,
"maximum": 200
}
},
"additionalProperties": false
}🔴quiz_video_delete_media(assetId)
Permanently delete a file from your library. Refused with a 409 while a quiz still uses it.
Eingabe-Schema
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
}
},
"required": [
"assetId"
],
"additionalProperties": false
}🟢quiz_video_get_quiz_media(quizId)
Read the media a quiz uses: background, intro and outro, sound effects, and each question and answer (their ids, images, clips and backgrounds).
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1
}
},
"required": [
"quizId"
],
"additionalProperties": false
}🔴quiz_video_update_quiz_media(quizId, quiz, questions, answers)
Attach uploaded files to a quiz. Omit a slot to leave it, send null to clear it. quiz: background (image or video, with dim 0.2-0.85), intro and outro (image or video, with seconds for an image, or trimStartSeconds, trimEndSeconds, audio "keep"|"mute" and volume for a video), soundEffects (enabled, correctAnswer, timerTick, countdownBeeps, transitions, each with a <name>Volume 0-1, and customAssets to use your own sound). questions[]: id with image, clip (a video played before the question, up to 60 seconds, which adds to the video length), background (or {"none": true} to turn the quiz background off). answers[]: id with image. Only asset ids from your own library are accepted.
Eingabe-Schema
{
"type": "object",
"properties": {
"quizId": {
"type": "string",
"minLength": 1
},
"quiz": {
"type": "object",
"additionalProperties": true
},
"questions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"answers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
},
"required": [
"quizId"
],
"additionalProperties": false
}⚪quiz_video_apply_template(templateId, quizIds)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"templateId": {
"type": "string",
"minLength": 1
},
"quizIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "Quiz ids to apply the template to."
}
},
"required": [
"templateId",
"quizIds"
],
"additionalProperties": false
}Community
Nachweis