video.quiz/api

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

Return the GET /api/v1 index: documentation and OpenAPI URLs, OAuth/API-key auth metadata, rate-limit and versioning policy, and every resource URL.

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.

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.

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

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.

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 file from your library. Refused with a 409 while a quiz still uses it.

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` 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.

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.

Read the media a quiz uses: background, intro and outro, sound effects, and each question and answer (their ids, images, clips and backgrounds).

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.

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

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.

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.

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.

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.

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