Courses
Get courses
GET /api/v1/headless/courses
Use this endpoint to get all your courses.
Query parameters
| Field | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
identifier | string | Filter to courses created by this identifier | Yes | N/A | N/A |
clientIdentifier | string | Filter to courses created by this clientIdentifier | Yes | N/A | N/A |
length | integer | Number of courses to return | Yes | N/A | N/A |
page | integer | Page of courses to return | Yes | N/A | N/A |
Responses
| Code | Description |
|---|---|
| default |
Get course
GET /api/v1/headless/courses/{id}
Use this endpoint to get a course by ID.
Path parameters
| Field | Description | Options |
|---|---|---|
id | Course ID | N/A |
Responses
| Code | Description |
|---|---|
| default |
Get a signed URL for a course
GET /api/v1/headless/course/{action}
Use this endpoint to get a signed URL for a course. This URL can be used to embed the Coassemble interface into your application within an iframe.
Note that the edit action is only available to workspaces that have access to Headless course creation.
In edit mode, you can specify the flow to open the course builder with:
| Flow | Description |
|---|---|
ai | Open course builder with the AI flow. This flow will guide the user through creating a course using our AI-powered course creation tool. |
document | Open course builder with the document flow. This flow will guide the user through creating a course by converting a document. |
presentation | Open course builder with the convert presentation flow. This flow will allow the user to convert a presentation to a course maintaining the original presentation structure and wording. |
preview | Open course builder in preview-only mode. This flow will allow the user to preview a course without being able to edit it. |
Path parameters
| Field | Description | Options |
|---|---|---|
action | Action to perform | N/A |
Query parameters
| Field | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
id | integer | Course ID. If not provided for edit action, will return a URL for a new course. | No | N/A | N/A |
identifier | string | Identifier for your user. In view mode will be used to track progress. In edit mode will be used to track course creation. | Yes | N/A | N/A |
clientIdentifier | string | Identify a client or group your user may belong to. Useful for multi-tenant situations where you would later like to differentiate between client's courses. | No | N/A | N/A |
flow | string | For edit mode, used to start the course builder in either the generate with AI or convert a document flow. | No | N/A | ai document presentation preview |
back | string | For edit mode, used to customise the back button behavior. In `event` mode it emits an event for your application to handle. In `hidden` mode the back button will not be shown. | No | "event" | hidden event |
colorPrimary | string | For edit mode, used to theme the course builder with a primary color. | No | N/A | N/A |
translations | boolean | For edit mode, opt in to allowing translations to be applied in the course builder. | No | false | N/A |
Responses
| Code | Description |
|---|---|
| 200 | Presigned URL to embed |
Duplicate a course Requires Headless course creation
POST /api/v1/headless/course/{id}/duplicate
Use this endpoint to duplicate an existing course.
You can optionally provide an identifier and clientIdentifier to assign the duplicated course to a new client or user within your environment.
Path parameters
| Field | Description | Options |
|---|---|---|
id | Course ID | N/A |
Body properties
| Field | Type | Description | Required | Options |
|---|---|---|---|---|
identifier | string | No | N/A | |
clientIdentifier | string | No | N/A |
Responses
| Code | Description |
|---|---|
| 200 | Course created |
Delete course
DELETE /api/v1/headless/course/{id}
Use this endpoint to delete an existing course.
Path parameters
| Field | Description | Options |
|---|---|---|
id | Course ID | N/A |
Responses
| Code | Description |
|---|---|
| 200 | Course deleted |
Export SCORM Requires Headless course creation
GET /api/v1/headless/course/scorm/{id}
Use this endpoint to export a SCORM package for a course.
Path parameters
| Field | Description | Options |
|---|---|---|
id | Course ID | N/A |
Responses
| Code | Description |
|---|---|
| default |