Skip to main content

Overview

A quiz video asks a series of multiple-choice questions. For each one a voice reads the question, the answer options appear, the viewer gets a few seconds to answer, and the correct option lights up. A title stays at the top for the whole video, and an outro closes it. You send the final list of questions: nothing is generated after the request, so what you send is what the video shows. Every request needs questions (2 to 10) and voiceId (from GET /v1/voice/list). Each question is { question, options, correctIndex }:
  • question: what the voice reads (it is also shown as the question’s caption);
  • options: 2 to 4 answers;
  • correctIndex: the position of the right answer in options, starting at 0. An index past the end of the list answers 400.

Quick Example

Without mediaType the quiz plays over gameplay footage (subway-s / subway-s-1). The create call answers with the projectId; poll GET /v1/project/{projectId} or pass a webhook to get the finished video.

Timing, Outro and Style

Parameters

Fields of optionsStyle, all optional: fontFamily, optionBackgroundColor, optionTextColor, correctBackgroundColor, showLetters (A, B, C, D before each answer), letterBackgroundColor, letterTextColor, textShadow. Gameplay clips: minecraft-1 to minecraft-9, subway-s-1 to subway-s-11, temple-run-1 to temple-run-8, gta-1 to gta-12, fortnite-1 to fortnite-5, roblox-1, free-fire-1 (the game is the part before the number). To use your own footage, send selectedGame: 'custom' and a video ID from your library as selectedVideo.
Managed teams are charged an estimate made from the narration and the media the background needs, when the project is created; it is refunded if the project fails.Teams in bring-your-own-keys mode are not charged credits for generation, but need their own OpenRouter and ElevenLabs keys in Settings → AI keys, plus Gemini when the AI video model is Omni Flash. Without them the call answers 402 with code: "missing_credentials" and the missingProviders list, before anything is created or charged. To retry a create call after a timeout or 5xx, send it with an Idempotency-Key: the same key never creates or charges twice.

Tips for Quiz Videos

Hook with the title: “Only 1% get all 3 right” gives viewers a reason to stay
Keep questions short: the voice reads every question, so short ones keep the pace up
Three or four options: enough to make the viewer think, few enough to read in time
Ask for the score: an outro that asks for comments drives engagement

Use Cases

  • Trivia channels: Geography, science, movies, sports
  • Education: Quick review quizzes for a lesson
  • Brand engagement: Questions about your product or industry
  • Community challenges: Series of quizzes with increasing difficulty

Handling the Webhook Response

Webhooks are signed: check the Hooked-Signature header as shown in Webhooks.