MyUstadia API

The API is organized around two creation paths. Both end at the same place: a generated multi-module video course delivered via signed asset URLs.

Option A: Preset flow (recommended for recurring clients)

Create a preset once per client company. Reuse it for every course you build for that company.

 POST   /api/v1/presets                          Create preset
 POST   /api/v1/presets/{id}/brand-assets        Upload logo + brand colors
 POST   /api/v1/presets/{id}/brand/generate      AI derives color palette (synchronous, returns artifact immediately)
 POST   /api/v1/presets/{id}/brand/approve
 POST   /api/v1/presets/{id}/slide-style/generate  (async, returns 202, poll setup-status)
 GET    /api/v1/presets/{id}/setup-status          Poll until slide_style = ready
 POST   /api/v1/presets/{id}/slide-style/approve
 POST   /api/v1/presets/{id}/voice-style/generate  (async, returns 202, poll setup-status)
 GET    /api/v1/presets/{id}/setup-status          Poll until voice_style = ready
POST   /api/v1/presets/{id}/voice-style/approve
POST   /api/v1/presets/{id}/questions/start        (company presets only)
GET    /api/v1/presets/{id}/questions/next         loop: get question
POST   /api/v1/presets/{id}/questions/answers      loop: answer
POST   /api/v1/presets/{id}/questions/validate
POST   /api/v1/presets/{id}/questions/approve      preset is now ready

    All `questions/*` and `brief/*` endpoints accept `?language=fr|en`
    (default `fr`). Prompts, help text, option labels and field labels
    are localized; English is full parity with French.

POST   /api/v1/presets/{id}/courses               Create course under the preset
GET    /api/v1/courses/{id}/brief/next            loop: get brief question
POST   /api/v1/courses/{id}/brief/answers         loop: answer
POST   /api/v1/courses/{id}/brief/validate
POST   /api/v1/courses/{id}/launch                (Idempotency-Key required)
GET    /api/v1/courses/{id}/status                poll until ready
GET    /api/v1/courses/{id}/modules/{n}/video     fetch deliverables

Steps 1 to 15 are the one-time preset setup. Steps 16 to 22 are the per-course flow. Once a preset exists, every new course for that company is six API calls (16 to 21) plus delivery fetches.

Preset types

Presets are created with a preset_type field:

`preset_type`	Description	Questionnaire required?
`company` (default)	Full sales-profile preset capturing the client’s buyer persona, pricing model, and sales motion	Yes (steps 11-15)
`theme`	Visual/voice branding only, no sales-profile questionnaire	No (skip steps 11-15; preset reaches `ready` on brand alone)

A theme preset is useful when you need consistent branding across courses but do not need a per-company sales profile.

What gates preset readiness

A preset reaches ready status when:

company preset: brand artifact approved and profile questionnaire approved.
theme preset: brand artifact approved.

slide-style and voice-style are optional refinements. Approving them improves generation quality but is not required for the preset to reach ready.

Option B: No-preset flow (quick start)

For one-off courses or low-volume use, skip the preset entirely. The brand is auto-derived from the source material.

 POST   /api/v1/courses/no-preset                  Create course (brand auto-derived)
 GET    /api/v1/courses/{id}/brief/next            loop
 POST   /api/v1/courses/{id}/brief/answers         loop
 POST   /api/v1/courses/{id}/brief/validate
 POST   /api/v1/courses/{id}/launch                (Idempotency-Key required)
 GET    /api/v1/courses/{id}/status                poll
 GET    /api/v1/courses/{id}/modules/{n}/video     fetch deliverables

Use this for the quickstart.

When to use which

Use case	Recommended path
One-off course for a single client	No-preset
Internal proof-of-concept	No-preset
Multiple courses for the same company	Preset
White-label LMS that serves many clients	Preset, one per client
ARESS-style scale (many companies, recurring courses)	Preset, with full setup automation

You can mix and match: nothing prevents creating no-preset courses on an account that also has presets.

Brief vs preset questions

Two questionnaires exist in the API, do not confuse them:

Preset questions (Option A only) capture the company’s sales profile: industry, target buyer persona, pricing model, sales motion. Asked once per preset.
Brief questions (both options) capture this course’s intent: target audience, learning objectives, tone. Asked once per course.

Both use the same next + answers loop pattern.

Review checkpoints

By default the pipeline pauses for human approval at up to three checkpoints during generation. See Review Checkpoints for the full model.

Async setup operations

Slide style and voice style generation are queued operations. They return 202 Accepted immediately. Poll GET /api/v1/presets/{id}/setup-status until each artifact reaches ready status before proceeding. Brand generation is synchronous. POST /api/v1/presets/{id}/brand/generate returns the artifact directly in the response body. There is no need to poll setup-status after brand/generate.

{
  "brand":       {"status": "ready"},
  "slide_style": {"status": "running"},
  "voice_style": {"status": "queued"}
}

Possible statuses: queued, running, ready, failed.

Get Started

Concepts

API Reference

Endpoints

Workflows

Option A: Preset flow (recommended for recurring clients)

Preset types

What gates preset readiness

Option B: No-preset flow (quick start)

When to use which

Brief vs preset questions

Review checkpoints

Async setup operations

​Option A: Preset flow (recommended for recurring clients)

​Preset types

​What gates preset readiness

​Option B: No-preset flow (quick start)

​When to use which

​Brief vs preset questions

​Review checkpoints

​Async setup operations

Option A: Preset flow (recommended for recurring clients)

Preset types

What gates preset readiness

Option B: No-preset flow (quick start)

When to use which

Brief vs preset questions

Review checkpoints

Async setup operations