Exams
Generate full HSC-style practice exam papers. Generation is asynchronous and the flow mirrors Quizzes. Requires the exams_api app.
- Create a paper with a subject, topics, duration and difficulty →
202 Accepted. - We generate the questions and render all three documents.
- You receive an
exam.completedwebhook once everything is ready (or poll the paper). - Retrieve the paper and fetch all three documents in your chosen format (
?delivery=htmlor?delivery=pdf). - To mark a sat paper, submit the student’s work to the Mark API with the paper’s
assessment_id.
The three documents
| Document | Description |
|---|---|
student_paper |
The questions the student sits |
writing_booklet |
A blank answer booklet |
solutions |
Worked solutions / marking guidelines |
Choose the format at fetch time: ?delivery=html returns inline HTML, ?delivery=pdf returns signed, expiring download URLs. You render them yourself.
Endpoints
- Create a paper —
POST /api/v1/exams/papers - Retrieve a paper —
GET /api/v1/exams/papers/:id