Skip to main content
Glama

api

by video.quiz

Create a quiz

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[].

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesHuman-readable quiz title.
formatNoOutput aspect ratio: "tiktok" (9:16 vertical) or "youtube" (16:9 horizontal).
quizTypeNoQuiz mechanic: multiple_choice, reveal_answer, or picture_guess.
templateNoVisual template id (e.g. "neon", "minimal").
questionsNoOptional initial questions with their answers and images.
difficultyNoTarget difficulty level for the generated/created quiz.
descriptionNoOptional longer description shown on the quiz page.
musicVolumeNoBackground music volume from 0 (silent) to 1 (full). Default 0.15.
countdownSecondsNoSeconds of countdown shown before each question (3–15).
themeDescriptionNoNatural-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.
backgroundMusicIdNoBackground music track id from /api/v1/music. Omit to use the default YouTube-safe shared track; set null for silent.
themeCustomizationNoExplicit custom theme to save and apply to the quiz. Invalid colors/fonts are ignored by the API sanitizer.

TDQS

A3.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate a write operation (readOnlyHint=false) and non-destructive behavior. The description adds helpful behavioral details beyond that: if themeDescription is omitted the server derives a theme, and backgroundMusicId defaults to YouTube-safe music or null for silent. This is meaningful context, though it doesn't cover return values or duplicate creation behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and front-loaded with the core purpose, then gives focused, high-value guidance on theming and music. The final required/optional list is somewhat redundant with the schema but is concise and not padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (12 parameters, nested questions, no output schema), the description summarizes key decision points well: custom theme preference, background music behavior, and required vs optional fields. It is not fully complete because it omits return-value expectations and sibling differentiation, but the rich schema covers parameter details.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all parameters. The description mainly restates required/optional and highlights theme/music defaults, adding limited new semantic value beyond the schema. This matches the baseline of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with 'Create a quiz,' clearly stating the action and resource. It is specific but does not explicitly differentiate from sibling tools like quiz_video_generate_quiz, so it misses the top score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides parameter-level recommendations ('Prefer sending themeDescription...', 'Omit backgroundMusicId...') and lists required/optional fields, but it gives no guidance on when to use this tool versus alternatives such as generate_quiz or update_quiz.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All api toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.7/5.0
Disambiguation5/5

Every tool targets a distinct resource and action (create/get/list/update/delete per entity). Overlapping pairs like get_render vs download_render are clearly differentiated by their purpose, and generate_quiz vs create_quiz serve different creation modes. There is no ambiguity between tools.

Naming Consistency4/5

The vast majority of tools follow a consistent 'quiz_video_<verb>_<noun>' pattern in snake_case. The only deviation is the three discovery tools (get_api_catalog, get_llms_txt, get_openapi_spec) which omit the 'quiz_video_' prefix, though they still use a clear verb_noun structure.

Tool Count3/5

With 30 tools, the server is on the heavier side and exceeds the typical 15-tool guideline. However, the count is justified by the breadth of resources covered (quizzes, questions, hooks, templates, flashcard decks, renders, music, account) and each tool has a distinct role, so the size feels appropriate for a comprehensive API surface.

Completeness4/5

The server covers full CRUD for most core resources (quizzes, templates, flashcard decks, hooks) and add/list for questions. Minor gaps include no individual question update/delete and no direct render deletion, but these are not critical and the main workflows (create → view → render → download) are fully covered.

Resources