In development
The docs that already exist
The public API is documented in English and French; other product facts live on the standards and security pages.
What the docs cover today
Figures from the published API catalogue, not a future list.
- OpenAPI spec
- 3.1OpenAPI specPublished at /docs/api
- API version
- 1API versionThe JSON spec is at /api/v1/openapi.json
- Official languages
- 2Official languagesEvery operation has an English and a French summary
- Silent English fallbacks
- 0Silent English fallbacksA missing French string fails the build
Where each topic lives
One page per topic, so a buyer does not hunt through a dump.
| Topic | Where to read it |
|---|---|
| REST API | /docs/api, OpenAPI 3.1 |
| SCORM 1.2 and 2004 | Standards page; export ships |
| xAPI | Standards page; LRS core, no HTTP routes on main |
| Security controls | Security page |
| Price | Pricing page; quoted, no rate card |
Questions about the docs
Is there a product handbook?
Not yet. The API spec, the standards page, and the security page are what exist today.
Are the API summaries bilingual?
Yes. Each operation carries an English summary and a French summary in the OpenAPI document.
Where is SCORM documented?
On the standards page. The exporter writes SCORM 1.2 or 2004 from the same course.
Is there an xAPI HTTP endpoint?
The statement store exists. The HTTP routes are not on main, so we do not publish them here.
Ask a documentation question
Write in English or French. Name the page or the endpoint.