api
Quiz.Video MCP: list, create, AI-generate, and render quiz and flashcard videos.
使うべきか
品質と安全性
検出事項(4)
- LOWquiz_video_add_quiz_questions 内
- LOWquiz_video_list_flashcard_decks 内
- LOWquiz_video_create_flashcard_deck 内
- LOWquiz_video_delete_flashcard_deck 内
ツール定義とプロトコルへの準拠に関する自動分析に基づいています。
コンテキストコスト
これは、サーバーのツールがモデルのコンテキストに読み込まれるたびに消費されるおおよそのトークン数です。数が多いほど、ほかのタスクに使える注意が減ります。
インストール
ワンクリックインストール
これを `claude_desktop_config.json` ファイルに追加してください:
{
"mcpServers": {
"api": {
"url": "https://www.quiz.video/mcp/"
}
}
}リモートエンドポイント
https://www.quiz.video/mcp/streamable-httpできること
ツール一覧
ツール(30)
🟢get_api_catalog
Return the Quiz.Video API catalog linkset for agent discovery.
入力スキーマ
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢get_openapi_spec
Return the Quiz.Video OpenAPI 3.1 specification.
入力スキーマ
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢get_llms_txt
Return a compact LLM-readable summary of the Quiz.Video API.
入力スキーマ
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢quiz_video_list_quizzes(page, limit)
List quizzes owned by the authenticated user with optional pagination (page, limit).
入力スキーマ
{
"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.
入力スキーマ
{
"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, format, quizType, template, ...)
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[].
入力スキーマ
{
"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."
},
"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."
},
"fontFamilyOverride": {
"type": "string",
"enum": [
"Inter",
"Poppins",
"Roboto",
"Montserrat",
"Open Sans",
"Lato",
"Oswald",
"Raleway",
"Playfair Display",
"Source Sans Pro"
],
"description": "Approved font family used for question and answer text."
}
},
"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, extraDirection, numberOfQuestions, answerOptionCount, difficulty, ...)
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.
入力スキーマ
{
"type": "object",
"properties": {
"topic": {
"type": "string",
"minLength": 1,
"description": "Subject the AI should build the quiz around."
},
"extraDirection": {
"type": "string",
"description": "Additional instructions to steer the AI (tone, focus areas, exclusions)."
},
"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",
"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."
},
"fontFamilyOverride": {
"type": "string",
"enum": [
"Inter",
"Poppins",
"Roboto",
"Montserrat",
"Open Sans",
"Lato",
"Oswald",
"Raleway",
"Playfair Display",
"Source Sans Pro"
],
"description": "Approved font family used for question and answer text."
}
},
"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.).
入力スキーマ
{
"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": "number",
"description": "Font size (px) for question text."
},
"answerFontSize": {
"type": "number",
"description": "Font size (px) for answer text."
},
"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",
"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",
"description": "Global timing multiplier applied to durations and animations."
},
"isPublished": {
"type": "boolean",
"description": "Whether the quiz is publicly listed on quiz.video."
},
"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."
},
"fontFamilyOverride": {
"type": "string",
"enum": [
"Inter",
"Poppins",
"Roboto",
"Montserrat",
"Open Sans",
"Lato",
"Oswald",
"Raleway",
"Playfair Display",
"Source Sans Pro"
],
"description": "Approved font family used for question and answer text."
}
},
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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).
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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).
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"type": "object",
"properties": {},
"additionalProperties": false
}🟢quiz_video_list_music
List available background music tracks.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"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.
入力スキーマ
{
"type": "object",
"properties": {
"templateId": {
"type": "string",
"minLength": 1
}
},
"required": [
"templateId"
],
"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.
入力スキーマ
{
"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
}コミュニティ
エビデンス