Skip to content

Embed overview

The REST API and embeddable components for creating, delivering and tracking courses inside your own product.

Embed lets you build training into your own product rather than sending people to a separate Coassemble site. You author, deliver and track courses through the Coassemble API and a set of embeddable components, so course creation and learning happen inside your own interface, under your own brand.

What you build runs on the same infrastructure as the rest of Coassemble: SOC 2 Type 1 and Type 2 reports behind it, and the Classic learner experience independently verified as conforming to WCAG 2.2 Level AA.

What you build with

Two ways to integrate, and most teams use both together.

  • The REST API. Create and manage courses and collections, generate content, identify learners, read tracking and results, and manage themes, translations and usage.
  • Embeddable components. Ready-made pieces you drop into your own pages, loaded in an iframe, in view mode (take a course) and edit mode (build a course).

Alongside these, your app can listen for in-page events as a learner moves through a course, and receive server-to-server webhooks when a course is created, started or completed.

The components

Course and collection level

  • Player components deliver a whole course or collection to a learner.
  • Card and List components present a single course or collection, or a browsable grid of them.
  • Builder components let your users author and edit a whole course or collection in your interface.
  • Analytics components surface course, collection and user-level dashboards.

Screen level

  • Screen Builder puts the screen editor inside your application, so a user creates or edits one screen rather than a whole course. Adding a screen opens the layout picker, or you can list the available layouts and create a screen directly if you'd rather build your own picker.
  • Screen Player renders a single screen for a learner. A standalone quiz embeds as a set, with scoring, retakes and results.

Screen-level components send screen start, completion, answers and scores to your application, and their built-in navigation can be hidden so your own controls take over. They carry an optional AI assistant, off by default and scoped to editing the screen it's on.

SCORM

You can also upload an existing SCORM package and host it in Coassemble alongside authored courses, with attempt tracking and question-level results.

Availability of individual components varies by plan. The current matrix is in the developer documentation.

What you can build with it

  • Deliver training inside your product. Place a course or collection player in an onboarding flow, a help centre or a customer portal, so learners take training without leaving your app.
  • Put a single screen in a workflow. Use Screen Player where a whole course is more than the moment needs, for example a knowledge check inside a task someone is already doing.
  • Let your own users create courses. Combine the builder components with the Generate API so the people using your product can build and edit courses themselves, in your interface.
  • Show results in your own dashboard. Use the analytics components, or pull tracking data through the API, to surface course and learner data alongside the rest of your reporting.
  • Serve multiple tenants. Scope users and content to your own tenants with a client identifier, so each of your customers sees only their own courses, learners and branding.

Because the learning runs inside your product, it's served from your own domain automatically, with no separate domain setup in Coassemble.

Where the full developer documentation lives

The complete reference, with endpoints, parameters and examples, is at developers.coassemble.com. Key sections:

Frequently asked questions

What's the difference between using the API and the embeddables?

The embeddable components are ready-made pieces you load into your pages, which is the fastest way to add a player, builder or analytics view. The API gives you direct control to build your own experience and to do things the components don't cover, like creating content programmatically or reading raw tracking data. You can use them together: embed a component for the interface, and call the API for the data and content behind it.

Can my users build their own courses inside my product?

Yes. The builder embeddables and the Generate API let the people using your product author and edit courses without leaving your app. Screen Builder does the same at the level of a single screen.

Can my product drive the AI agent?

Yes. Your application can drive the same agent over MCP or REST, scoped to a single course, with control over which tools are available and a read-only mode if you need one.

Can I keep each customer's content and learners separate?

Yes. A client identifier scopes users and content to your own tenants, so each customer sees only their own courses, learners and branding.

Where do I get API keys?

API keys are created in your Coassemble workspace settings. Authentication details are covered in the Get started guide.