intu ai Support & Docs
← Home Sign in →
POST /api/v1/naplan/attempts

Create a NAPLAN attempt

Builds an MCQ attempt (Numeracy / Reading / Conventions) and returns the question set synchronously (201 Created) — including answer keys, worked solutions and per-distractor misconception tags, so you can deliver and (optionally) mark it yourself.

Parameters

Name Type Required Description
user_id string required Your identifier for the student (root of body)
year_level integer required 3, 5, 7 or 9
domain string optional numeracy (default), reading or conventions
skill_key string optional Restrict to one skill (see List skills); disables adaptive
adaptive boolean optional Opt into multistage adaptive (default off)
paper boolean optional Build a full sectioned practice paper instead of a short set
limit integer optional Number of questions for a fixed-form set (default 10, max 30)

If the pool has no questions for that domain/year yet, you get 409 NAPLAN_ERRORS::POOL_NOT_READY and generation is triggered in the background — retry shortly.

Returns

The attempt with its current-stage questions. Each question carries question_id, item_type (mcq/numeric_entry/multi_select), question_text, optional stimulus, keyed options (omitted for numeric_entry), the answer (correct_keys, answer_text, worked_solution), distractors and skill. Submit answers to submit_url.