Skip to main content
POST
Question set

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
text
string
required

The source material to write questions from.

Required string length: 1 - 50000
type
string
required

Question format, e.g. multiple-choice, short-answer, true-false.

Required string length: 1 - 60
numberOfQuestions
integer
required

How many to produce, 1–20.

Required range: 1 <= x <= 20
difficulty
string

e.g. easy, exam, olympiad.

Maximum string length: 60
subject
string

The subject, for correct terminology.

Maximum string length: 200
gradeLevel
string

Who is sitting it, e.g. undergraduate.

Maximum string length: 50
projectId
string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success
boolean
required
projectId
string
required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

Example:

"prj_9x2a4c"

credits
number
required

What this call actually cost, which is not always what was quoted.

Example:

300

questions
any
required

The question set, with answers where the format has them.

creditBalance
number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}
any