`quiz`

One multiple-choice question with the answer key, so the client grades locally. The next question, and the grading of the reply, come when the user's reply follows our question's text unchanged; the last answer, or stopping, is a text-only answer (with the score once a question was answered).

Version 1 · schema quiz.v1.schema.json

Not answered yet: the API sends no quiz cards for now, and such questions come back matched: false (not billed). The type stays in the contract, so handle it like any other.

Layouts

Every card type has full. Pick a layout with the element's layout attribute, render.layout, or a theme.

full

Fields

The fields of card.data. Values a source doesn't provide are null; new optional fields can appear within version 1.

Field	Type	Required	Notes
`topic`	`string`	yes
`index`	`integer`	yes
`total`	`integer`	yes
`question`	`string`	yes
`options[]`	`object[]`	yes
`options[].key`	`string`	yes
`options[].text`	`string`	yes
`answer_key`	`string`	yes
`explanation`	`string`	yes
`score`	`integer \| null`		Correct answers so far in this round.
`previous`	`null \| object`	yes	How the user did on the previous question of the round, if any.
`previous.given`	`string`	yes
`previous.correct`	`boolean`	yes
`previous.correct_answer`	`string`	yes

Example

A recorded answer to “Quiz me on world capitals”. Open it in the Answer Lab to see every layout and style.

Response

1{
2  "v": 2,
3  "id": "ans_dnzgrfmzirz1b6pg",
4  "matched": true,
5  "locale": "en",
6  "skill": "quiz",
7  "confidence": 0.9,
8  "text": "Question 1 of 5 (World capitals): What is the capital city of Costa Rica? A) Majuro, B) San Jose, C) Port of Spain, D) Andorra la Vella.",
9  "speech": "Let's play! Question 1 of 5: What is the capital city of Costa Rica? A: Majuro, B: San Jose, C: Port of Spain or D: Andorra la Vella.",
10  "card": {
11    "type": "quiz",
12    "version": 1,
13    "data": {
14      "topic": "World capitals",
15      "index": 1,
16      "total": 5,
17      "question": "What is the capital city of Costa Rica?",
18      "options": [
19        {
20          "key": "A",
21          "text": "Majuro"
22        },
23        {
24          "key": "B",
25          "text": "San Jose"
26        },
27        {
28          "key": "C",
29          "text": "Port of Spain"
30        },
31        {
32          "key": "D",
33          "text": "Andorra la Vella"
34        }
35      ],
36      "answer_key": "B",
37      "explanation": "",
38      "score": 0,
39      "previous": null
40    }
41  },
42  "sources": [
43    {
44      "name": "The Trivia API",
45      "url": "https://the-trivia-api.com/",
46      "license": "CC BY-NC 4.0"
47    }
48  ],
49  "follow_ups": [
50    "Skip",
51    "Stop the quiz"
52  ],
53  "actions": [],
54  "usage": {
55    "billable": true
56  }
57}