NAPLAN Writing

Get an original writing prompt, submit the student’s typed response, and receive a rubric-based mark. Only typed text is accepted — there is no file upload; OCR any handwritten work to text on your side before submitting.

POST /api/v1/naplan/writing_attempts · PATCH /api/v1/naplan/writing_attempts/:id · GET /api/v1/naplan/writing_attempts/:id

Create parameters

Name	Type	Required	Description
user_id	string	required	Your identifier for the student
year_level	integer	required	3, 5, 7 or 9
text_type	string	optional	narrative or persuasive (otherwise random)

Create returns 201 with a prompt (title, text_type, prompt_text, optional stimulus) and a submit_url.

Submit parameters

Name	Type	Required	Description
user_id	string	required	Your identifier for the student
essay	string	required	The student’s typed response

Submit returns 202; marking is asynchronous (naplan.completed webhook or poll). Once marked, GET returns result: overall_band, total_marks, max_marks, overall_comment, the student’s essay_text, and per-criteria { key, name, max, score, feedback }.