Login

Courses

Get courses

GET /api/v1/headless/courses

Use this endpoint to get all your courses.

Query parameters

FieldTypeDescriptionRequiredDefaultPattern
identifierstringFilter to courses created by this identifierYes N/A N/A
clientIdentifierstringFilter to courses created by this clientIdentifierYes N/A N/A
lengthintegerNumber of courses to returnYes N/A N/A
pageintegerPage of courses to returnYes N/A N/A

Responses

CodeDescription
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.

Path parameters

FieldDescriptionOptions
actionAction to perform N/A

Query parameters

FieldTypeDescriptionRequiredDefaultPattern
idintegerCourse ID. If not provided for edit action, will return a URL for a new course.Yes N/A N/A
identifierstringIdentifier 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
clientIdentifierstringIdentify 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
flowstringFor edit mode, used to start the course builder in either the generate with AI or convert a document flow.Yes N/A N/A

Responses

CodeDescription
200Presigned URL to embed

Delete course

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

Use this endpoint to delete an existing course.

Path parameters

FieldDescriptionOptions
idCourse ID N/A

Responses

CodeDescription
200Course deleted