API Documentation

🚧 Coming soon

The public API and hosted embedding isn’t quite ready yet — we’re actively working on it.

For timing, planned milestones, and progress updates, please check our public roadmap:

View the public roadmap → 

If you’d like to influence priority or request specific features, join the waitlist or reach out via our support channels.

The Teacharium public API allows you to programmatically access your organization’s lessons and integrate them into your applications.

Getting Started

Before using the API, you’ll need to:

1. Create an API token - Only organization administrators can create tokens. See API Tokens for instructions.
2. Understand authentication - All API requests require a Bearer token. See Authentication for details.

Available Endpoints

General

• List Lessons - Retrieve published lessons from your organization

Embedding

• Embedding APIs Overview - Learn about embedding lessons in your application
• Sign Token - Generate signed JWT tokens for embedding lessons
• Embed Player Data - Retrieve lesson data for embedded players

Common Concepts

Authentication

All API endpoints require authentication using Bearer tokens. Tokens are organization-specific and consist of a public key and secret key.

Read the full authentication documentation →

Response Format

All successful responses return JSON data with a consistent structure:

{
  "data": [...]
}

Error Handling

Errors are returned with appropriate HTTP status codes and a JSON body:

{
  "error": "Error message description"
}

Common status codes:

• 401 - Authentication failed
• 422 - Invalid request parameters
• 500 - Internal server error

Data Types

• UUID: String format "550e8400-e29b-41d4-a716-446655440000"
• ISO 8601 Timestamps: String format "2025-01-15T10:30:00Z"
• Arrays: Always returned as arrays, even if empty []

Support

If you encounter issues or have questions about the API, please contact support or check our support documentation.