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
aidocumentpresentationpreview
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"
hiddenevent
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
language
string
For view mode, set the language of the course rather than relying on the browser's language setting. This should be a valid ISO 639-1 language code. If the language is not available, the default course language will be used.
Note that this endpoint is designed for you to give your users a way to export their course as a SCORM package for use in a third party LMS. It is not recommended that you use this endpoint instead of Headless signed URLs for embedding courses.
Use this endpoint to export a SCORM package for a course.