-
Notifications
You must be signed in to change notification settings - Fork 2
1.5 API
Martin Stierlen edited this page Mar 5, 2026
·
4 revisions
What you will find on this page 🦉
- SwaggerAPI - Interactive SwaggerAPI docs
- API Endpoints - Same as SwaggerAPI, but not as beautiful :)
Click here to visit the official SwaggerAPI docs of ExplAIner.
Health
| Method | Path | Description |
|---|---|---|
GET |
/api/health |
Health check |
Learning Goals
| Method | Path | Description |
|---|---|---|
POST |
/api/learning-goals |
Generate 3 learning goals (AI) from topic + optional prior knowledge |
POST |
/api/learning-goals/easier |
Generate easier goals based on a previous session's context |
Sessions
| Method | Path | Description |
|---|---|---|
POST |
/api/sessions |
Create a new session |
GET |
/api/sessions/:sessionId |
Get full session with all blocks (client rehydration) |
DELETE |
/api/sessions/:sessionId |
Delete session (cascades to all blocks) |
PATCH |
/api/sessions/:sessionId/current-block-index |
Update current block index + mark block as viewed |
POST |
/api/sessions/:sessionId/continue |
Decide next action: `navigate |
PUT |
/api/sessions/:sessionId/feedback |
Submit 1–5 star rating |
Blocks
| Method | Path | Description |
|---|---|---|
POST |
/api/sessions/:sessionId/blocks/sequence |
Generate next block sequence (1 Inform + 3 Practice) |
POST |
/api/sessions/:sessionId/blocks/summary |
Generate summary block |
GET |
/api/sessions/:sessionId/blocks/:orderIndex |
Get a single block by order index |
POST |
/api/sessions/:sessionId/blocks/:orderIndex/messages |
Send follow-up question → get AI response |
PUT |
/api/sessions/:sessionId/blocks/:orderIndex/student-answer |
Submit practice block answer |
