Lumen developer docs

Lumen is a study app for HSC students, used in the browser. For developers and AI agents there's a small public read-only API, an OpenAPI spec, Markdown pages and an llms.txt guide.

Authentication

The public API needs no key and no sign-in. It only returns public facts about Lumen. Students' own work (papers, marks, notes, flashcards, chats) is private to their account and isn't available through any API. Lumen's other /api routes are called by Lumen's own app with a session cookie; called without one, they answer 401 with code signed-out.

Endpoints

Base URL https://www.getlumen.au. The full spec is OpenAPI 3.1 at /openapi.json.

GET /api/v1/plans (listPlans): Free and Paid with prices (AUD), what each includes and their limits, plus the trial, credit packs and the HSC pass.
GET /api/v1/courses (listCourses): Courses with a fixed syllabus topic list, each with its slug and topics in order.
GET /api/v1/courses/{slug} (getCourse): One course by slug, such as biology or mathematics-extension-1.

curl https://www.getlumen.au/api/v1/plans
curl https://www.getlumen.au/api/v1/courses/biology

Errors

Errors from every /api path are JSON with a stable code, a sentence saying what went wrong, a hint and a link here:

HTTP/1.1 404 Not Found
content-type: application/json

{
  "code": "course-not-found",
  "error": "There's no course \"astrology\".",
  "hint": "List the courses and their slugs with GET /api/v1/courses.",
  "docs": "https://www.getlumen.au/developers"
}

Codes you may see: not-found, course-not-found, signed-out, daily-limit (a student reached a limit). Responses are cached for an hour or more, so there's no need to call them often.

Pages for agents

/llms.txt: what Lumen is, when to send someone here, and when not to.
The home page as Markdown: request / with Accept: text/markdown.
A path that doesn't exist answers a real 404, in Markdown if you ask for it.
/sitemap.xml lists every public page.

curl -H 'Accept: text/markdown' https://www.getlumen.au/

Contact

Questions about the API, or want something added? Email hello@getlumen.au.

Authentication

Endpoints

Base URL https://www.getlumen.au. The full spec is OpenAPI 3.1 at /openapi.json.

GET /api/v1/plans (listPlans): Free and Paid with prices (AUD), what each includes and their limits, plus the trial, credit packs and the HSC pass.

GET /api/v1/courses (listCourses): Courses with a fixed syllabus topic list, each with its slug and topics in order.

GET /api/v1/courses/{slug} (getCourse): One course by slug, such as biology or mathematics-extension-1.

curl https://www.getlumen.au/api/v1/plans curl https://www.getlumen.au/api/v1/courses/biology

Errors

Errors from every /api path are JSON with a stable code, a sentence saying what went wrong, a hint and a link here:

HTTP/1.1 404 Not Found content-type: application/json { "code": "course-not-found", "error": "There's no course \"astrology\".", "hint": "List the courses and their slugs with GET /api/v1/courses.", "docs": "https://www.getlumen.au/developers" }

Codes you may see: not-found, course-not-found, signed-out, daily-limit (a student reached a limit). Responses are cached for an hour or more, so there's no need to call them often.

Pages for agents

/llms.txt: what Lumen is, when to send someone here, and when not to.

The home page as Markdown: request / with Accept: text/markdown.

A path that doesn't exist answers a real 404, in Markdown if you ask for it.

/sitemap.xml lists every public page.

curl -H 'Accept: text/markdown' https://www.getlumen.au/