Manage products and content using CourseLit API
The CourseLit public API can manage products and course content programmatically. Use it when you are building another frontend for CourseLit, such as an AI-assisted learning app that creates courses, uploads media, and publishes products through CourseLit.
For interactive schemas and examples, open the Swagger API reference from your CourseLit dashboard.
Authentication
Send your API key in the x-api-key header.
curl https://your-school.example.com/api/products \
-H "x-api-key: your-api-key" \
-H "accept: application/json"API keys are school-level credentials. CourseLit resolves the school owner for the current domain and uses that owner as the actor for permission checks and resource ownership. Do not send creatorId, userId, or similar ownership fields unless an endpoint explicitly documents the field as the customer being managed.
Product workflow
Create a product as a draft first.
POST /api/productsThe draft creation endpoint accepts only:
{
"title": "AI Foundations",
"type": "course"
}After the draft exists, update metadata with:
PATCH /api/products/{productId}Use this endpoint for fields such as slug, description, published, privacy, tags, and featuredImage. description is a JSON-stringified Tiptap/ProseMirror document.
Do not use the legacy course.cost or course.costType fields. Pricing is managed with payment plans.
Payment plans
Course and download products require a payment plan before publishing. Use:
GET /api/products/{productId}/payment-plans
POST /api/products/{productId}/payment-plans
GET /api/products/{productId}/payment-plans/{planId}
PATCH /api/products/{productId}/payment-plans/{planId}
DELETE /api/products/{productId}/payment-plans/{planId}
POST /api/products/{productId}/payment-plans/{planId}/defaultDeleting a payment plan archives it. The API follows the same validations as the dashboard, including checks for paid plans and default payment plans.
Sections and lessons
Structured products can be organized with sections and lessons.
GET /api/products/{productId}/sections
POST /api/products/{productId}/sections
PATCH /api/products/{productId}/sections/{sectionId}
DELETE /api/products/{productId}/sections/{sectionId}
POST /api/products/{productId}/sections/reorder
GET /api/products/{productId}/lessons
POST /api/products/{productId}/lessons
GET /api/products/{productId}/lessons/{lessonId}
PATCH /api/products/{productId}/lessons/{lessonId}
DELETE /api/products/{productId}/lessons/{lessonId}
POST /api/products/{productId}/lessons/{lessonId}/moveText lessons accept Tiptap/ProseMirror JSON in content.
Supported document nodes include:
docparagraphheadingwithlevel1, 2, or 3textbulletList,orderedList, andlistItemblockquotehorizontalRulecodeBlocktable,tableRow,tableHeader, andtableCellimagehardBreak
Supported text marks include:
bolditalicunderlinestrikecodelinkhighlight
{
"title": "Welcome to Rust",
"type": "text",
"content": {
"type": "doc",
"content": [
{
"type": "heading",
"attrs": { "level": 2 },
"content": [{ "type": "text", "text": "Install Rust" }]
},
{
"type": "paragraph",
"content": [
{ "type": "text", "text": "Install " },
{
"type": "text",
"marks": [{ "type": "bold" }],
"text": "rustup"
},
{
"type": "text",
"text": " and create your first project."
}
]
},
{
"type": "bulletList",
"content": [
{
"type": "listItem",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Run the installer."
}
]
}
]
}
]
},
{
"type": "blockquote",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"marks": [
{
"type": "link",
"attrs": {
"href": "https://www.rust-lang.org/tools/install"
}
}
],
"text": "Rust installation guide"
}
]
}
]
},
{ "type": "horizontalRule" },
{
"type": "codeBlock",
"attrs": { "language": "bash" },
"content": [{ "type": "text", "text": "cargo new hello-rust" }]
},
{
"type": "table",
"content": [
{
"type": "tableRow",
"content": [
{
"type": "tableHeader",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Command"
}
]
}
]
},
{
"type": "tableHeader",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Purpose"
}
]
}
]
}
]
},
{
"type": "tableRow",
"content": [
{
"type": "tableCell",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "cargo run"
}
]
}
]
},
{
"type": "tableCell",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Build and run the project"
}
]
}
]
}
]
}
]
}
]
}
}Images can be included in text lesson documents with an image node. The attrs object requires src and may include alt and title:
{
"type": "image",
"attrs": {
"src": "https://cdn.example.com/image.png",
"alt": "Diagram",
"title": "Diagram"
}
}Use a URL that is already accessible to learners, or upload to MediaLit and use the returned media URL.
SCORM lesson creation is not supported by the public API. If you send a SCORM lesson type, the API returns a not_supported error.
Media-backed lessons
Upload files directly to MediaLit, then reference the returned mediaId when creating or updating video, audio, PDF, or file lessons.
- Generate an upload signature:
POST /api/media/presigned- Upload the file to MediaLit using the returned
signatureandendpoint.
See the MediaLit upload guide: https://docs.medialit.cloud/api/uploadMedia.
- Reference the uploaded media in a lesson:
{
"title": "Lecture video",
"type": "video",
"media": {
"mediaId": "media_123"
}
}Publishing
Publish with:
PATCH /api/products/{productId}Set published to true only after the product is ready and has the required payment plan setup. The API uses existing CourseLit publishing validation.