API reference¶
Every operation below accepts an API key (Authorization: Bearer <key>). Examples are generated from the live OpenAPI schema, which is also published as openapi.json.
| Operation | Endpoint |
|---|---|
| List chapters | GET /api/v1/agent/courses/{course_pk}/chapters/ |
| Create a chapter | POST /api/v1/agent/courses/{course_pk}/chapters/ |
| Get a chapter | GET /api/v1/agent/courses/{course_pk}/chapters/{id}/ |
| Replace a chapter | PUT /api/v1/agent/courses/{course_pk}/chapters/{id}/ |
| Update a chapter | PATCH /api/v1/agent/courses/{course_pk}/chapters/{id}/ |
| Delete a chapter | DELETE /api/v1/agent/courses/{course_pk}/chapters/{id}/ |
| List courses | GET /api/v1/agent/courses/ |
| Create a course | POST /api/v1/agent/courses/ |
| Get a course | GET /api/v1/agent/courses/{id}/ |
| Replace a course | PUT /api/v1/agent/courses/{id}/ |
| Update a course | PATCH /api/v1/agent/courses/{id}/ |
| Delete a course | DELETE /api/v1/agent/courses/{id}/ |
| Who am I | GET /api/v1/agent/whoami/ |
| List lessons | GET /api/v1/agent/courses/{course_pk}/chapters/{chapter_pk}/lessons/ |
| Create a lesson | POST /api/v1/agent/courses/{course_pk}/chapters/{chapter_pk}/lessons/ |
| Get a lesson | GET /api/v1/agent/courses/{course_pk}/chapters/{chapter_pk}/lessons/{id}/ |
| Update a lesson | PATCH /api/v1/agent/courses/{course_pk}/chapters/{chapter_pk}/lessons/{id}/ |
| Delete a lesson | DELETE /api/v1/agent/courses/{course_pk}/chapters/{chapter_pk}/lessons/{id}/ |
| Get organisation settings | GET /api/v1/agent/org-settings/ |
| Update organisation settings | PATCH /api/v1/agent/org-settings/ |