Quizzes

Generate and persist a quiz with AI

post/api/v1/quizzes/generate

Request

  • Base URL: https://www.quiz.video
  • URL: https://www.quiz.video/api/v1/quizzes/generate
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://www.quiz.video/api/auth/oauth2/authorize, token URL https://www.quiz.video/api/auth/oauth2/token, scopes: api:read)
    • OpenID Connect (https://www.quiz.video/.well-known/openid-configuration, scopes: api:read)

Request body

topicstring required

Short topic or detailed brief (up to 20,000 characters).

extraDirectionstring
numberOfQuestionsinteger
answerOptionCount3 | 4
difficulty'easy' | 'medium' | 'hard' | 'rising'
quizType'multiple_choice' | 'reveal_answer' | 'picture_guess'
format'tiktok' | 'youtube'
countdownSecondsinteger
templatestring
progressBarStyle'circle' | 'line'
backgroundMusicIdinteger nullable

Omit to use the default YouTube-safe shared track; set null for silent.

musicVolumenumber
themeDescriptionstring

Natural-language prompt used to generate and save a custom visual theme.

Response

Successful response

Example response

{
  "data": {
    "format": "tiktok",
    "quizType": "multiple_choice"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.