Api

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

No parameters. Call it with no arguments.

Return the Quiz.Video OpenAPI 3.1 specification.

No parameters. Call it with no arguments.

Return a compact LLM-readable summary of the Quiz.Video API.

No parameters. Call it with no arguments.

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

No parameters. Call it with no arguments.

List quizzes owned by the authenticated user with optional pagination (page, limit).

Fetch a single quiz (including settings and metadata) by id.

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

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

Update a quiz. `updates` accepts any subset of quiz settings (title, description, format, template, timing, music, TTS, publish status, etc.).

Permanently delete a quiz and all of its questions, answers, and hooks.

List questions (and their answers) for a quiz.

Append one or more questions (with their answers and optional images) to an existing quiz.

List video hooks configured for a quiz.

Create a hook for a quiz. `hook` is a pass-through object whose fields follow the HookInput schema (see OpenAPI spec).

Update an existing hook on a quiz. Requires quizId and numeric hookId; `updates` is a partial HookInput.

Delete a single hook from a quiz.

List flashcard decks owned by the authenticated user with optional pagination.

Fetch a flashcard deck (including all cards) by id.

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

Permanently delete a flashcard deck and all of its cards.

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

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.

Request a signed download URL for a completed render.

Get the authenticated user's account info, plan, and usage limits.

No parameters. Call it with no arguments.

List available background music tracks.

No parameters. Call it with no arguments.

List the caller's saved custom templates (and optionally public ones). Templates are reusable scene-based designs that can be applied to many quizzes.

Fetch a single custom template (including the full scenes/layers payload) by id.

Save a new custom template authored in the drag-and-drop editor. Required: template (the CustomTemplate JSON). Optional: name, description, thumbnail, isDefault, isPublic.

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

Permanently delete a custom template you own. Quizzes that have a snapshot of this template are unaffected — the snapshot remains in their themeCustomization.

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

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.

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

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.

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.

Permanently delete a file from your library. Refused with a 409 while a quiz still uses it.

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

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

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.