Guides¶

End-to-end walkthroughs for flows that span multiple API calls.

The API reference documents every endpoint individually. These guides show how endpoints fit together when you're doing something real. If you haven't yet, skim Core concepts first — the guides assume you know how content items, assignments, and events relate.

Working with content and learners¶

• Assignments & completion — assign content to users, drive the completion lifecycle, and read results as analytics.
• Building learning paths (Tracks) — assemble ordered, sectioned learning paths and track learner progress.
• Bulk operations & async jobs — act on many resources at once, and the two bulk patterns (async-poll vs. synchronous).
• Automated rule runs — trigger an automated rule on demand, and poll or subscribe to webhooks for its outcome.
• Cascaded settings — read where a setting's value comes from, override it on one resource, or drop the override to follow the level above.
• Managing groups — create a group, hand it to other owners, and delete it once nothing is restricted to it.

Live events¶

• Events lifecycle — event series, scheduling events, enrolling attendees, and check-in.
• Office hour series — create a series of bookable sessions, set its managers, read its sessions, and set its cancellation deadline.
• Uploading recordings — attach a Mux-hosted recording to an event series.

Authoring content¶

• Writing content bodies in Markdown — author the formatted body of any content item, and what survives a read-modify-write cycle.
• Uploading a video — link an external video or upload one natively via Mux.
• Managing transcripts — download, edit, and re-upload a video's transcript; for native videos this also republishes the player captions.
• Building a course — upload a SCORM package and configure passing thresholds.
• Building a guide — upload an interactive, step-based codelab.
• Uploading a cover image — put a cover image on any content item, by upload or from a URL.
• Personal content — list a user's Personal items, their library and profile, and the Admin oversight option.