/generate-quiz

Create a new quiz with custom settings and receive a unique quiz ID + quiz data.

Input Parameters

Parameter	Type	Default	Description
numQuizzes	Int	1	The number of quizzes you want to generate. Optional.
numQuestions	Int	10	Number of questions in the quiz. Optional.
subject	String	null	The subject of the quiz. Optional.
instructions	String	null	Instructions for the quiz. Optional.
gradeLevel	String	null	Target grade level. Optional.
difficulty	String	null	Difficulty level. Options: "", Easy, Medium, Hard. Optional. Note: If left blank... the difficulty of the quiz will be set at the AI's discretion.
pdfLinks	Array of Strings	null	Link your PDF(s) to the prompt for quiz generation via file URLs. Optional
videoLinks	Array of Strings	null	Link your videos (.mp4 or youtube) to the prompt for quiz generation. Currently in closed beta, inquire with sales to access.
files	Array of FIles	null	Upload a file directly using form data, it works the same as "pdfLinks".

Note: For subject, instructions, and gradeLevel... if either one is left blank, the AI will use any of the values as context in order to create the quiz. If nothing is passed, you will generate a random quiz.

Example Request

// Example to generate a quiz
fetch('https://api.arlinear.com/functions/v1/generate-quiz', {
    method: 'POST',
    headers: {
        'Authorization': '<Your API Key>',
    },
    body: JSON.stringify({
	'numQuizzes': 2,
        'subject': 'Math',
        'instructions': 'A quiz on basic algebra',
        'gradeLevel': 'grade 6',
        'difficulty': 'Medium',
        'numQuestions': 20
    })
})

Return Value

• quizzes

  • An array of quizzes.

  • quizId: A unique identifier for the generated quiz.

  • title: The title of the quiz.

  • questions: The questions in the quiz.

{
    "quizzes": [ // list of quizzes
	{
	  "quizId": "ba777045-7033-4701-b17b-da9e90dcd41e",
	  "title": "Basic Algebra Quiz 1",
	  "questions": [
            {
                "id": "d93bdcaf-0490-4cb7-af55-bfcb07c33332",
                "type": "mc",
                "value": "What is the result of 5 + 2 * 3?",
                "choices": [
                    {
                        "value": " 11",
                        "isCorrect": true,
                        "type": "choice"
                    },
                    {
                        "value": " 14",
                        "isCorrect": false,
                        "type": "choice"
                    },
                    {
                        "value": " 9",
                        "isCorrect": false,
                        "type": "choice"
                    }
                ]
            },
            {
                "id": "d93bdcaf-0490-4cb7-af55-bfcb07c33332",
                "type": "short",
                "value": "Solve for x: 3x + 2 = 8",
                "gradingCriteria": "Grading Criteria: \"This quiz is for 1st graders. They should be able to perform simple order of operations.\""
            }
	  ]
	},
	{
	  "quizId": "ba777045-7033-4701-b17b-da9e90dcd41e",
	  "title": "Basic Algebra Quiz 2",
	  "questions": [...]
	},
    ]
}