API

The Teacharium API provides programmatic access to your organization’s lessons and enables embedding lessons in 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.

API Reference

• API Tokens - Create and manage API tokens for authentication
• Authentication - Learn how to authenticate API requests
• List Lessons - Retrieve published lessons from your organization
• 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 []