Mark My Words API

TL;DR: One API that the Mark My Words app, partner platforms and publisher platforms all call. Students write on paper, AI drafts the marking against a rubric, and a teacher approves every mark before a student sees it.

What you can do with it

  • Mark answers. Send answers and a mark scheme, and read back a draft marking for each question.
  • Read handwriting. Upload a page image and read back its transcription.
  • Draft feedback. Ask for feedback on a marked answer, for a teacher to edit and approve.
  • Work with schools. With a school's grant, read its classes and enrolments and create submissions for it.

What the API never does

These rules hold for every key, whatever a school has granted your organisation.

  1. A key never approves or releases a mark. Only a signed-in teacher or school admin does, in the app. A key that tries gets 403 agent_not_allowed.
  2. Every marking the API returns is unreviewed. Show it to a teacher, never to a student.
  3. Student data stays in Australia. The API runs in AWS Sydney, and no student work trains a model.
  4. Every create is idempotent. Send an Idempotency-Key header with each create, and a repeated request is never marked twice.

Where to start

  • Authentication: how to get a key and send it.
  • Quickstart: three requests with a sandbox key.
  • Error codes: every refusal and what to do about it.
  • Versioning and the changelog: what may change on /v1, and what did.
  • The API reference: every route, generated from the OpenAPI document.

Status

Nothing is in production. The API runs on AU staging with synthetic data only. Sandbox keys run on a stand-in marking engine that costs nothing and answers at once.