Courses

Get courses

GET /api/v1/headless/courses

Use this endpoint to get all your courses.

Field	Type	Description	Required	Default	Pattern
`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

Code	Description
default

GET /api/v1/headless/courses/{id}

Use this endpoint to get a course by ID.

Field	Description	Options
`id`	Course ID	N/A

Code	Description
default

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.

Field	Description	Options
`action`	Action to perform	N/A

Field	Type	Description	Required	Default	Pattern
`id`	`integer`	Course ID. If not provided for edit action, will return a URL for a new course.	Yes	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.	Yes	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.	Yes	N/A	N/A

Code	Description
200	Presigned URL to embed

DELETE /api/v1/headless/course/{id}

Use this endpoint to delete an existing course.

Field	Description	Options
`id`	Course ID	N/A

Code	Description
200	Course deleted