{"openapi":"3.1.0","info":{"title":"Lumen public API","version":"1.0.0","summary":"Read-only facts about Lumen: plans, prices, limits and supported courses.","description":"Lumen is an AI study app for Australian high school students (the NSW HSC). This API is public, read-only and needs no key. Students' own work is private and isn't available through any API. Errors are JSON with a stable `code`, a human `error` message, a `hint` and a `docs` link.","contact":{"name":"Lumen","email":"hello@getlumen.au","url":"https://www.getlumen.au/contact"},"termsOfService":"https://www.getlumen.au/terms"},"externalDocs":{"description":"Lumen developer docs","url":"https://www.getlumen.au/developers"},"servers":[{"url":"https://www.getlumen.au"}],"security":[],"tags":[{"name":"Plans","description":"What Lumen costs and what each plan includes."},{"name":"Courses","description":"Courses with a fixed NSW syllabus topic list in Lumen."}],"paths":{"/api/v1/plans":{"get":{"operationId":"listPlans","tags":["Plans"],"summary":"List Lumen's plans and prices","description":"Free and Paid with their prices (AUD), what each includes and their limits, plus the trial, credit packs and the HSC pass. Cached for an hour.","responses":{"200":{"description":"Plans, prices and limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plans"}}}}}}},"/api/v1/courses":{"get":{"operationId":"listCourses","tags":["Courses"],"summary":"List courses with syllabus topics","description":"Courses whose NSW syllabus topics Lumen lays out in order, for coverage and revision plans. Students can study any course; these are the ones with a fixed topic list.","responses":{"200":{"description":"Courses and their topics.","content":{"application/json":{"schema":{"type":"object","required":["courses"],"properties":{"courses":{"type":"array","items":{"$ref":"#/components/schemas/Course"}}}}}}}}}},"/api/v1/courses/{slug}":{"get":{"operationId":"getCourse","tags":["Courses"],"summary":"Get one course's syllabus topics","description":"One course by its slug (from listCourses), with its topics in syllabus order.","parameters":[{"name":"slug","in":"path","required":true,"description":"The course's slug, such as `biology` or `mathematics-extension-1`.","schema":{"type":"string","pattern":"^[a-z0-9-]+$"}}],"responses":{"200":{"description":"The course.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Course"}}}},"404":{"description":"No course with that slug (code `course-not-found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","required":["code","error","hint","docs"],"properties":{"code":{"type":"string","description":"Stable machine-readable code, such as `not-found` or `signed-out`."},"error":{"type":"string","description":"What went wrong, in a sentence."},"hint":{"type":"string","description":"What to do about it."},"docs":{"type":"string","format":"uri","description":"Where to read more."}}},"Course":{"type":"object","required":["name","slug","topics"],"properties":{"name":{"type":"string","examples":["Biology"]},"slug":{"type":"string","examples":["biology"]},"topics":{"type":"array","items":{"type":"string"},"description":"Syllabus topics in order."}}},"Plans":{"type":"object","required":["currency","note","trial","plans","creditPacks","hscPass"],"properties":{"currency":{"type":"string","const":"AUD"},"note":{"type":"string"},"trial":{"type":"object","required":["credits","days","card","description"],"properties":{"credits":{"type":"integer"},"days":{"type":"integer"},"card":{"type":"boolean","description":"Whether a card is needed."},"description":{"type":"string"}}},"plans":{"type":"array","items":{"type":"object","required":["id","name","description","price","includes","limits"],"properties":{"id":{"type":"string","enum":["free","paid"]},"name":{"type":"string"},"description":{"type":"string"},"price":{"type":"object","required":["monthly","yearly"],"properties":{"monthly":{"type":"number"},"yearly":{"type":"number"}}},"includes":{"type":"array","items":{"type":"string"}},"limits":{"type":"object","additionalProperties":{"type":"integer"},"description":"Daily (and monthly) limits by kind."}}}},"creditPacks":{"type":"array","items":{"type":"object","required":["id","credits","price","expires"],"properties":{"id":{"type":"string"},"credits":{"type":"integer"},"price":{"type":"number"},"expires":{"type":"boolean"}}}},"hscPass":{"type":"object","required":["description","pricesByMonth","onSaleNow"],"properties":{"description":{"type":"string"},"pricesByMonth":{"type":"array","items":{"type":"object","required":["month","price"],"properties":{"month":{"type":"integer","minimum":1,"maximum":12},"price":{"type":"number"}}}},"onSaleNow":{"type":"boolean"}}}}}}}}