# Teacharium > Teacharium is a platform for authoring interactive lessons: branching scenarios, simulations, quizzes and AI-assisted content, delivered on the web or embedded in other sites. This is the AI-readable version of the Teacharium documentation at https://docs.teacharium.io. - Every page below is plain markdown. Any docs page URL also works with `.md` appended. - The whole documentation in one file: https://docs.teacharium.io/llms-full.txt - To create or edit lessons from an AI client, connect the Teacharium MCP server: https://app.teacharium.io/api/mcp (setup: https://docs.teacharium.io/docs/share-your-work/bring-your-own-agent.md) ## Overview - [Teacharium user guide](https://docs.teacharium.io/index.md): Watch complete projects come together from start to finish — then try it yourself. ## User Documentation - [User Documentation](https://docs.teacharium.io/docs.md): Welcome to the Teacharium user documentation. Use the sidebar to navigate, or browse by section below. - [What Is Teacharium?](https://docs.teacharium.io/docs/get-started/what-is-teacharium.md): Teacharium is a lesson builder for creating interactive learning experiences. You design lessons with drag-and-drop components, then deploy them however you... - [How Teacharium Works](https://docs.teacharium.io/docs/get-started/core-concepts.md): Understand the building blocks of every Teacharium lesson before you start creating. - [Lesson abstract](https://docs.teacharium.io/docs/build-your-lesson/lesson-abstract.md): The lesson abstract is a description that lets an author plan what will appear in a lesson. It’s the place to capture the lesson’s goals, target learners, sc... - [Write and format text](https://docs.teacharium.io/docs/build-your-lesson/writing-and-formatting.md): Add and style text content in your lesson steps. - [Add images and media](https://docs.teacharium.io/docs/build-your-lesson/images-and-media.md): Use images to make your lessons visually engaging and easier to understand. - [Using the Grid Layout](https://docs.teacharium.io/docs/build-your-lesson/grid-layouts.md): The grid layout system lets you divide a step into sections and place components precisely where you want them. - [Choose lesson fonts](https://docs.teacharium.io/docs/build-your-lesson/lesson-fonts.md): Give your lesson its own look by choosing two fonts from Google Fonts : a decorative font for headings and a body font for everything else. - [Animate between steps](https://docs.teacharium.io/docs/build-your-lesson/step-transitions.md): A step transition is the animation learners see each time they move from one step to the next. It applies to the whole lesson, so every step change uses the... - [Text to Speech Options](https://docs.teacharium.io/docs/build-your-lesson/voice-and-narration.md): Add voice narration to your lessons using Teacharium's built-in text-to-speech. - [Create your first quiz](https://docs.teacharium.io/docs/build-your-lesson/creating-a-quiz.md): Build a quiz step where learners answer questions, get feedback, and progress when they're done. - [Adding Questions](https://docs.teacharium.io/docs/build-your-lesson/adding-questions.md): Teacharium has several built-in question types. Each one pairs with a logic controller that determines how learners interact with it — how many tries they ge... - [Step templates](https://docs.teacharium.io/docs/build-your-lesson/step-templates.md): Step templates let you save a step's layout and content so you can reuse it later. - [Branching Lessons](https://docs.teacharium.io/docs/make-it-interactive/branching-lessons.md): Send learners down different paths through your lesson based on their choices or performance. - [Variables and Interactive Controls](https://docs.teacharium.io/docs/make-it-interactive/variables-and-interactive-controls.md): Use variables to connect components and create lessons that respond to learner input. - [Create a Branching Dialogue Lesson](https://docs.teacharium.io/docs/see-it-built/branching-dialogue.md): Build a branching scenario where learners make decisions that lead to different outcomes and personalized feedback. This walkthrough uses a paramedic emergen... - [Build a Chemistry Simulation](https://docs.teacharium.io/docs/see-it-built/chemistry-simulation.md): What if your learners could pour chemicals, watch reactions happen, and learn from their mistakes — all inside a lesson? This project combines branching logi... - [Create a Learning Inventory with Teacharium AI](https://docs.teacharium.io/docs/see-it-built/learning-inventory.md): Build a learning inventory — a survey-style lesson that assesses how learners prefer to learn, then visualizes their results. This walkthrough shows how to u... - [Build a Custom Results Widget](https://docs.teacharium.io/docs/see-it-built/results-widget.md): Your learning inventory captures learner preferences — now give them something beautiful to look at. In this guide, you'll build a custom radar chart widget... - [Build a Cuban Missile Crisis Lesson](https://docs.teacharium.io/docs/see-it-built/cuban-missile-crisis.md): Build a historical decision-making scenario where learners step into the role of President Kennedy during the Cuban Missile Crisis. This walkthrough shows ho... - [Publishing & delivering lessons](https://docs.teacharium.io/docs/share-your-work/publishing.md): When your lesson is ready for learners, you can publish it directly from the lesson editor. Each published version is a snapshot of your lesson at that point... - [Embed in your site](https://docs.teacharium.io/docs/share-your-work/embedding.md): Deliver lessons directly within your website or application using Teacharium's embedding options. - [LTI integration](https://docs.teacharium.io/docs/share-your-work/lti.md): This guide is coming soon. Teacharium supports LTI (Learning Tools Interoperability) for connecting lessons directly to your LMS. - [Bring your own agent](https://docs.teacharium.io/docs/share-your-work/bring-your-own-agent.md): Connect the AI agent you already use, such as Claude Code, Claude.ai, Codex, or Cursor, to Teacharium and let it build and revise your lessons for you. - [Multiple Choice](https://docs.teacharium.io/docs/reference/multiple-choice.md): Create single- or multi-select questions with customizable choices and feedback. Multiple Choice items are versatile and work well for knowledge checks, quiz... - [Matching](https://docs.teacharium.io/docs/reference/matching.md): Ask learners to drag answers to matching question stems. Matching items are ideal for connecting related concepts, vocabulary, definitions, or any paired rel... - [Ordering](https://docs.teacharium.io/docs/reference/ordering.md): Let learners drag items into the correct sequence. Ordering items are perfect for teaching chronological events, step-by-step processes, or any content that... - [Fill in the Blank](https://docs.teacharium.io/docs/reference/fill-in-the-blank.md): Create questions where learners type an answer or select from a dropdown. Fill in the Blank items support text and numeric answers with flexible validation,... - [Cloze Question](https://docs.teacharium.io/docs/reference/cloze-question.md): A cloze question (also known as fill-in-the-blanks) presents learners with a passage of text containing one or more blank spaces. Learners must fill in the c... - [Matrix Choice](https://docs.teacharium.io/docs/reference/matrix-choice.md): Present a matrix question where each row selects from multiple answer columns. Matrix Choice items are perfect for evaluating multiple statements against the... - [This Or That](https://docs.teacharium.io/docs/reference/this-or-that.md): Create preference-based choice questions where learners select one option from mutually exclusive alternatives. Each selection increments a variable associat... - [Navigation Choice](https://docs.teacharium.io/docs/reference/navigation-choices.md): Present multiple navigation options that allow learners to choose their own path through a lesson. Navigation Choice widgets are perfect for choose-your-own-... - [Logic widgets](https://docs.teacharium.io/docs/reference/logic-gating.md): Logic widgets control the flow and behavior of your lessons. They work behind the scenes to manage navigation, show/hide content, and orchestrate interactive... - [Items overview](https://docs.teacharium.io/docs/reference/scoring-and-feedback.md): Items are interactive experiences that a user can work through that you can add to your lessons to assess learner understanding and create engaging learning... - [Practice mode with hints](https://docs.teacharium.io/docs/reference/practice-and-hints.md): Give learners multiple attempts and progressive hints to master difficult material. - [Widgets overview](https://docs.teacharium.io/docs/reference/widget-library.md): Widgets are interactive elements you can add to your lessons to create engaging learning experiences. The widgets section keeps your organization's widgets s... - [Support overview](https://docs.teacharium.io/docs/support.md): Teacharium offers two types of support to help you get the most out of our platform. ## Developer Documentation - [Developer Documentation](https://docs.teacharium.io/api-documentation.md): The public API and hosted embedding isn't quite ready yet — we're actively working on it. - [API](https://docs.teacharium.io/api-documentation/api.md): The Teacharium API provides programmatic access to your organization's lessons and enables embedding lessons in your applications. - [API tokens](https://docs.teacharium.io/api-documentation/api/api-tokens.md): API tokens allow you to integrate Teacharium with your website or application. Only admins can create or revoke tokens, and the secret value is shown only on... - [Authentication](https://docs.teacharium.io/api-documentation/api/authentication.md): All Teacharium public API endpoints require authentication using API tokens. Tokens are organization-specific and allow secure access to your organization's... - [List Lessons](https://docs.teacharium.io/api-documentation/api/list-lessons.md): Retrieve a list of published lessons from your organization. - [Export Lesson](https://docs.teacharium.io/api-documentation/api/export-lesson.md): Export a published lesson version as a self-contained ZIP file containing all lesson content, media assets, and widget bundles. - [Sign Token](https://docs.teacharium.io/api-documentation/api/sign-token.md): Generate a signed JWT token for embedding lessons on external sites. This token can be used to securely authenticate and authorize access to specific lessons. - [Embed Player Data](https://docs.teacharium.io/api-documentation/api/embed-player-data.md): Retrieve lesson data for embedded players using JWT token authentication. This endpoint is designed for displaying lessons in embedded iframes on external we... - [Get Learner Progress](https://docs.teacharium.io/api-documentation/api/get-learner-progress.md): Retrieve a learner's progress and scores for a specific lesson. Two endpoints are available depending on your integration type: Embed (for embedded lessons)... - [Hosted Embedding](https://docs.teacharium.io/api-documentation/hosted-embedding.md): Learn how to embed Teacharium lessons on your website or application using secure iframe-based embedding with JWT authentication. - [SDK Reference](https://docs.teacharium.io/api-documentation/hosted-embedding/sdk-reference.md): The function accepts the following options: - [Examples](https://docs.teacharium.io/api-documentation/hosted-embedding/examples.md): Create a responsive embed that adjusts to different screen sizes: - [Security & Troubleshooting](https://docs.teacharium.io/api-documentation/hosted-embedding/security.md): Error: "Token verification failed: Token expired" - [Self-Hosted Embedding](https://docs.teacharium.io/api-documentation/self-hosted-embedding.md): The is a self-contained React component for embedding Teacharium lessons in your application. It handles all provider setup internally, making integration st... - [Props Reference](https://docs.teacharium.io/api-documentation/self-hosted-embedding/props-reference.md): You must provide either or : - [Session State & Types](https://docs.teacharium.io/api-documentation/self-hosted-embedding/session-state.md): The player uses to track the learner's progress through a lesson. This includes: - [Configuration & Modes](https://docs.teacharium.io/api-documentation/self-hosted-embedding/configuration.md): The prop accepts these options: - [Media Resolution](https://docs.teacharium.io/api-documentation/self-hosted-embedding/media-resolution.md): Lessons may reference media files (images, videos, voiceovers) by ID. You provide resolver hooks that map these IDs to actual URLs. - [Lesson Fonts](https://docs.teacharium.io/api-documentation/self-hosted-embedding/fonts.md): Authors can give a lesson two Google Fonts : a display (decorative) font for H1 and H2 headings and a body font for everything else (see Choose lesson fonts ). - [Saving & Resuming Progress](https://docs.teacharium.io/api-documentation/self-hosted-embedding/saving-progress.md): The player does not have any built-in mechanism to fetch or decide on session state. Whether a lesson resumes or starts fresh is entirely controlled by wheth... - [Complete Example](https://docs.teacharium.io/api-documentation/self-hosted-embedding/complete-example.md) ## Sample Lessons - [Sample Lessons](https://docs.teacharium.io/sample-lessons.md): Explore interactive sample lessons built with Teacharium. - [Branching Dialogue](https://docs.teacharium.io/sample-lessons/branching-dialogue.md): Interactive lesson (open in a browser to try it): https://docs.teacharium.io/sample-lessons/branching-dialogue - [Chemistry: Acid Titration Simulation](https://docs.teacharium.io/sample-lessons/acid-titration.md): Interactive lesson (open in a browser to try it): https://docs.teacharium.io/sample-lessons/acid-titration - [Learning Inventory](https://docs.teacharium.io/sample-lessons/learning-inventory.md): Interactive lesson (open in a browser to try it): https://docs.teacharium.io/sample-lessons/learning-inventory - [Cuban Missile Crisis](https://docs.teacharium.io/sample-lessons/cuban-missile-crisis.md): Interactive lesson (open in a browser to try it): https://docs.teacharium.io/sample-lessons/cuban-missile-crisis