Courses

Courses are learning objects within Coassemble. Using the API, you can fetch and delete courses as well as get a signed URL for courses for embedding.

Get courses Pulse and above

Use this endpoint to get all your courses. By default only non-deleted courses are returned; set the deleted query parameter to true to include soft-deleted courses.

GET/v1/headless/courses

Query parameters

Field	Type	Required	Default	Options
`identifier`	`string`	No	—	—
`clientIdentifier`	`string`	No	—	—
`length`	`number`	No	`100`	—
`page`	`number`	No	`0`	—
`title`	`string`	No	—	—
`deleted`	`boolean`	No	`false`	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/v1/headless/courses?identifier=user_123&clientIdentifier=client_123&length=100&page=0&title=Workplace+Safety&deleted=false" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

[
  {
    "id": 1234,
    "active": false,
    "title": "Workplace Safety",
    "description": "example",
    "image": "example",
    "thumbnail": "example",
    "thumbnailRevision": "example",
    "thumbnailOutdated": false,
    "start": null,
    "finish": null,
    "screens": [],
    "theme": null,
    "folder": null,
    "identified": false,
    "private": false,
    "paid": false,
    "price": 1,
    "key": "abc123",
    "identifier": "user_123",
    "clientIdentifier": "client_123",
    "revision": "example",
    "published": "2026-05-27T14:31:49.757Z",
    "translations": [
      "example"
    ],
    "created": "2026-05-27T14:31:49.757Z",
    "updated": "2026-05-27T14:31:49.757Z",
    "deleted": "2026-05-27T14:31:49.757Z"
  }
]

Get course Pulse and above

Use this endpoint to get a course by ID.

GET/v1/headless/courses/{id}

Path parameters

Field	Description	Options
`id`	Course ID	—

Query parameters

Field	Type	Required	Default	Description	Options
`identifier`	`string`	No	—		—
`clientIdentifier`	`string`	No	—		—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/v1/headless/courses/1234?identifier=user_123&clientIdentifier=client_123" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

{
  "id": 1234,
  "active": false,
  "title": "Workplace Safety",
  "description": "example",
  "image": "example",
  "thumbnail": "example",
  "thumbnailRevision": "example",
  "thumbnailOutdated": false,
  "start": null,
  "finish": null,
  "screens": [],
  "theme": null,
  "folder": null,
  "identified": false,
  "private": false,
  "paid": false,
  "price": 1,
  "key": "abc123",
  "identifier": "user_123",
  "clientIdentifier": "client_123",
  "revision": "example",
  "published": "2026-05-27T14:31:49.757Z",
  "translations": [
    "example"
  ],
  "created": "2026-05-27T14:31:49.757Z",
  "updated": "2026-05-27T14:31:49.757Z",
  "deleted": "2026-05-27T14:31:49.757Z"
}

Get a signed URL for a course [GET] (Deprecated)

info

This endpoint is deprecated. Please use the POST /v1/headless/embed/course endpoint instead. See recommended alternative →

GET/v1/headless/course/{action}

Path parameters

Field	Description	Options
`action`	view (learner) or edit (authoring)	`viewedit`

Query parameters

Field	Type	Required	Default	Options
`id`	`string`	No	—	—
`identifier`	`string`	Yes	—	—
`clientIdentifier`	`string`	No	—	—
`flow`	`string`	No	—	`aidocumentpresentationpreviewgeneratetransformconvert`
`back`	`string`	No	—	`eventhiddennative`
`colorPrimary`	`string`	No	—	—
`translations`	`boolean`	No	—	—
`language`	`string`	No	—	—
`brandVoice`	`boolean`	No	—	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/v1/headless/course/view?id=1234&identifier=user_123&clientIdentifier=client_123&flow=ai&back=event&colorPrimary=example&translations=true&language=es&brandVoice=true" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

"https://api.coassemble.com/embed/abc123def456"

Get a signed URL for a course [POST] (Deprecated)

info

This endpoint is deprecated. Please use the POST /v1/headless/embed/course endpoint instead. See recommended alternative →

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.

POST/v1/headless/course/url

Body parameters

Field	Type	Required	Desc	Options
`action`	`string`	Yes	view (learner) or edit (authoring)	`viewedit`
`id`	`string`	No	Course ID (required when action is view)	—
`identifier`	`string`	Yes	Your stable user identifier	—
`clientIdentifier`	`string`	No	The client this user belongs to	—
`themeId`	`number`	No	Theme ID to render the embed with	—
`name`	`string`	No	Display name for the learner	—
`avatar`	`string`	No	Avatar URL for the learner	—
`options`	`object`	No		—

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/v1/headless/course/url" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "action": "view",
    "identifier": "user_123",
    "id": 1234,
    "clientIdentifier": "client_123"
}'

Response

JSON response

"https://api.coassemble.com/embed/abc123def456"

Duplicate a course Embed Core and above

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.

POST/v1/headless/course/{id}/duplicate

Path parameters

Field	Description	Options
`id`	Source course ID	—

Body parameters

Field	Type	Required	Desc	Options
`identifier`	`string`	No	Override identifier on the duplicate	—
`clientIdentifier`	`string`	No	Override client identifier on the duplicate	—

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/v1/headless/course/1234/duplicate" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "identifier": "user_123",
    "clientIdentifier": "client_123"
}'

Response

JSON response

{
  "id": 1234,
  "active": false,
  "title": "Workplace Safety",
  "description": "example",
  "image": "example",
  "thumbnail": "example",
  "thumbnailRevision": "example",
  "thumbnailOutdated": false,
  "start": null,
  "finish": null,
  "screens": [],
  "theme": null,
  "folder": null,
  "identified": false,
  "private": false,
  "paid": false,
  "price": 1,
  "key": "abc123",
  "identifier": "user_123",
  "clientIdentifier": "client_123",
  "revision": "example",
  "published": "2026-05-27T14:31:49.757Z",
  "translations": [
    "example"
  ],
  "created": "2026-05-27T14:31:49.757Z",
  "updated": "2026-05-27T14:31:49.757Z",
  "deleted": "2026-05-27T14:31:49.757Z"
}

Delete course Embed Core and above

Use this endpoint to delete an existing course. The course is soft-deleted and can be restored with the restore endpoint.

DELETE/v1/headless/course/{id}

Path parameters

Field	Description	Options
`id`	Course ID	—

Examples

cURL request

curl --request DELETE \
  --url "https://api.coassemble.com/v1/headless/course/1234" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

false

Restore a course Embed Core and above

Use this endpoint to restore a soft-deleted course.

POST/v1/headless/course/{id}/restore

Path parameters

Field	Description	Options
`id`	Course ID	—

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/v1/headless/course/1234/restore" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

false

Export SCORM Embed Core and above

info

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 signed URLs for embedding courses. See recommended alternative →

Use this endpoint to export a SCORM package for a course.

GET/v1/headless/course/scorm/{id}

Path parameters

Field	Description	Options
`id`	Course ID	—

Query parameters

Field	Type	Required	Default	Description	Options
`type`	`string`	No	—		`dynamicstatic`
`version`	`string`	No	—		`1.22004`

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/v1/headless/course/scorm/1234?type=dynamic&version=1.2" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Generate a course (Deprecated) Embed Core and above

info

This endpoint is deprecated. Please use the POST /v1/headless/generate/course endpoint instead. See recommended alternative →

This legacy route is still available for backwards compatibility and delegates to the new generate controller.

POST/v1/headless/course/generate

Body parameters

Field	Type	Required	Desc	Options
`prompt`	`string`	Yes	The topic or learning objective to generate a course from	—
`audience`	`string`	Yes	Who the course is for (e.g. "new hires")	—
`familiarity`	`string`	Yes	How familiar the audience is with the topic (e.g. "beginner")	—
`tone`	`string`	Yes	Tone of voice for the generated content (e.g. "professional")	—
`screenCount`	`number`	Yes	Approximate number of screens to generate	—
`identifier`	`string`	Yes	Your stable identifier for the course owner	—
`clientIdentifier`	`string`	No	The client this course belongs to	—

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/v1/headless/course/generate" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "prompt": "Create a short onboarding course.",
    "audience": "new hires",
    "familiarity": "beginner",
    "tone": "professional",
    "screenCount": 8,
    "identifier": "user_123"
}'

Response

JSON response

{
  "id": 1234,
  "active": false,
  "title": "Workplace Safety",
  "description": "example",
  "image": "example",
  "thumbnail": "example",
  "thumbnailRevision": "example",
  "thumbnailOutdated": false,
  "start": null,
  "finish": null,
  "screens": [],
  "theme": null,
  "folder": null,
  "identified": false,
  "private": false,
  "paid": false,
  "price": 1,
  "key": "abc123",
  "identifier": "user_123",
  "clientIdentifier": "client_123",
  "revision": "example",
  "published": "2026-05-27T14:31:49.758Z",
  "translations": [
    "example"
  ],
  "created": "2026-05-27T14:31:49.758Z",
  "updated": "2026-05-27T14:31:49.758Z",
  "deleted": "2026-05-27T14:31:49.758Z"
}

Publish a course Embed Automate and above

Use this endpoint to publish a course programmatically.

POST/v1/headless/course/{id}/publish

Path parameters

Field	Description	Options
`id`	Course ID	—

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/v1/headless/course/1234/publish" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Revert a course Embed Automate and above

Use this endpoint to revert a course to its published version programmatically.

POST/v1/headless/course/{id}/revert

Path parameters

Field	Description	Options
`id`	Course ID	—

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/v1/headless/course/1234/revert" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"