Submit & retrieve a NAPLAN attempt

Submit the student’s responses for the current stage, then fetch the diagnostic.

PATCH /api/v1/naplan/attempts/:id · GET /api/v1/naplan/attempts/:id

Submit parameters

Name	Type	Required	Description
`user_id`	string	required	Your identifier for the student
`responses`	array	required	`{ question_id, selected_key, time_taken_ms }` per answered question

selected_key is the chosen option key for MCQ, an array of keys for multi_select, or the typed value for numeric_entry.

Behaviour:

Adaptive, not the final stage → 200 OK with the next stage’s questions (routed by your accuracy).
Final stage (or non-adaptive) → 202 Accepted; marking runs asynchronously. Await the naplan.completed webhook or poll GET.

Retrieve

GET returns the live questions while in_progress, a marking in progress note while submitted, and the full report once marked: overall_band (needs_support/developing/strong/exceeding), overall_rating, per-skill skill_metrics, difficulty_accuracy, misconceptions, pacing, ranked recommendations, parent_narration (+ student_narration for Years 7/9), plus per-question responses.

cURL

curl -X PATCH "https://ai.intu.com.au/api/v1/naplan/attempts/9f8e7d6c-..." \
  -H "Authorization: Token token=sk_intu_api_<your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "student-001",
    "responses": [
      { "question_id": "aaaa-...", "selected_key": "A", "time_taken_ms": 4200 }
    ]
  }'

Response

{
  "attempt_id": "9f8e7d6c-...",
  "status": "marked",
  "domain": "numeracy",
  "year_level": 5,
  "report": {
    "overall_band": "strong",
    "overall_rating": 0.42,
    "response_count": 10,
    "skill_metrics": [{ "skill_key": "N5.A1", "accuracy": 0.8, "band": "strong", "misconceptions": {} }],
    "recommendations": [{ "skill_key": "N5.A2", "band": "developing", "next_step": { "type": "practice" } }],
    "parent_narration": "...",
    "student_narration": null
  },
  "responses": [{ "question_id": "aaaa-...", "selected_key": "A", "correct": true }]
}