> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myustadia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Turn URLs, PDFs, and source documents into branded multi-module video courses via API

The MyUstadia API (also referred to as the MAHARA Platform API) turns raw source material into fully produced, multi-module sales training video courses. Each course is Coursera or LinkedIn Learning style: narrated MP4 video per module, branded slide images, AI-written study notes, and a module quiz plus cross-module final exam.

Clients call this API directly to automate course creation inside their own LMS, dashboard, or CI pipeline.

## What you can build

* **Internal LMS course factories**: feed in a sales playbook PDF, get back a branded video course your team can publish in your LMS.
* **Per-client course generation**: create a `preset` per company (brand colors, voice style, sales profile), then spin up new courses against that preset on demand.
* **Embedded course creation flows**: white-label the create-course experience inside your own dashboard via the brief and review endpoints.

## How it works

The API is organized around two creation paths.

<CardGroup cols={2}>
  <Card title="Option A: Preset" icon="layer-group" href="/workflows">
    A reusable brand-and-profile object captures a company's logo, colors, voice, and sales profile once. Every subsequent course for that company runs against the preset.
  </Card>

  <Card title="Option B: No Preset" icon="bolt" href="/workflows">
    Throw-away brand derived on the fly. Useful for one-off or low-volume use.
  </Card>
</CardGroup>

Both paths share the same brief-then-launch flow, the same review checkpoints, and the same delivery endpoints.

## Where to start

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Build a course end-to-end in under 10 minutes with `sk_test_` keys (free).
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Get an API key and understand sandbox vs live key behaviour.
  </Card>

  <Card title="Workflows" icon="route" href="/workflows">
    Walk through both creation paths and review checkpoints.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Every endpoint, every parameter, with try-it-now from this page.
  </Card>
</CardGroup>

## Status

This documentation describes API v2 (released 2026). The base URL is `https://api.myustadia.com`. All endpoints below are relative to that base URL.
