Skip to main content
POST
/
api
/
v1
/
quizzes
/
generate
Generate a quiz with AI
curl --request POST \
  --url https://quizquail.com/api/v1/quizzes/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topic": "Ancient Roman history",
  "options": {
    "rounds": 5,
    "questionsPerRound": 10,
    "difficulty": 3,
    "questionTypes": [
      "<string>"
    ],
    "questionDurationSeconds": 16.5,
    "answerDurationSeconds": 8.5,
    "factDurationSeconds": 8.5,
    "hintTimingPercent": 50
  }
}
'
import requests

url = "https://quizquail.com/api/v1/quizzes/generate"

payload = {
"topic": "Ancient Roman history",
"options": {
"rounds": 5,
"questionsPerRound": 10,
"difficulty": 3,
"questionTypes": ["<string>"],
"questionDurationSeconds": 16.5,
"answerDurationSeconds": 8.5,
"factDurationSeconds": 8.5,
"hintTimingPercent": 50
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
topic: 'Ancient Roman history',
options: {
rounds: 5,
questionsPerRound: 10,
difficulty: 3,
questionTypes: ['<string>'],
questionDurationSeconds: 16.5,
answerDurationSeconds: 8.5,
factDurationSeconds: 8.5,
hintTimingPercent: 50
}
})
};

fetch('https://quizquail.com/api/v1/quizzes/generate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://quizquail.com/api/v1/quizzes/generate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'topic' => 'Ancient Roman history',
'options' => [
'rounds' => 5,
'questionsPerRound' => 10,
'difficulty' => 3,
'questionTypes' => [
'<string>'
],
'questionDurationSeconds' => 16.5,
'answerDurationSeconds' => 8.5,
'factDurationSeconds' => 8.5,
'hintTimingPercent' => 50
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://quizquail.com/api/v1/quizzes/generate"

payload := strings.NewReader("{\n \"topic\": \"Ancient Roman history\",\n \"options\": {\n \"rounds\": 5,\n \"questionsPerRound\": 10,\n \"difficulty\": 3,\n \"questionTypes\": [\n \"<string>\"\n ],\n \"questionDurationSeconds\": 16.5,\n \"answerDurationSeconds\": 8.5,\n \"factDurationSeconds\": 8.5,\n \"hintTimingPercent\": 50\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://quizquail.com/api/v1/quizzes/generate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"topic\": \"Ancient Roman history\",\n \"options\": {\n \"rounds\": 5,\n \"questionsPerRound\": 10,\n \"difficulty\": 3,\n \"questionTypes\": [\n \"<string>\"\n ],\n \"questionDurationSeconds\": 16.5,\n \"answerDurationSeconds\": 8.5,\n \"factDurationSeconds\": 8.5,\n \"hintTimingPercent\": 50\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://quizquail.com/api/v1/quizzes/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"topic\": \"Ancient Roman history\",\n \"options\": {\n \"rounds\": 5,\n \"questionsPerRound\": 10,\n \"difficulty\": 3,\n \"questionTypes\": [\n \"<string>\"\n ],\n \"questionDurationSeconds\": 16.5,\n \"answerDurationSeconds\": 8.5,\n \"factDurationSeconds\": 8.5,\n \"hintTimingPercent\": 50\n }\n}"

response = http.request(request)
puts response.read_body
"<string>"
{
"type": "https://quizquail.com/problems/validation-error",
"title": "Validation Error",
"status": 400,
"detail": "Request validation failed",
"instance": "<string>",
"errors": [
{
"field": "title",
"message": "Title is required",
"code": "too_small"
}
]
}

Authorizations

Authorization
string
header
required

API key authentication. Prefix your key with Bearer in the Authorization header.

Keys follow the format qq_... and can be scoped to specific permissions.

Body

application/json
topic
string
required

Topic for AI quiz generation

Required string length: 1 - 500
Example:

"Ancient Roman history"

options
object

Response

SSE stream of generation progress

Server-Sent Events stream