Discovery

Discovery endpoints are agent-native: they let an AI agent (or your own code)
learn the shape of an academy — its capabilities, field limits, live structure,
and content-block schemas — before making any write.

All discovery endpoints are read-only.

Endpoints

Capabilities

GET /capabilities — what this key can do

Constraints

GET /constraints — field limits, enums, and data-model relationships

Overview

GET /overview — the live structure: courses ↔ modules ↔ lessons ↔ quizzes,
plus pricing and landing pages

Block schemas

GET /schemas/lesson-blocks and GET /schemas/page-blocks — per-block config
fields and styling

Readiness

Before publishing, check whether a course is complete:

GET /v1/courses/{course_id}/readiness

Block shape

Lesson and page blocks use the canonical shape:

{ "id": "blk_1", "block_type": "text", "sort_order": 0, "config": { } }

Text blocks accept rich HTML.

🤖

Start any automation with GET /constraints and GET /overview — they tell an agent exactly which fields and enums are valid before it writes.


Did this page help you?