Skip to main content
POST
Draft a course from videos

Authorizations

x-access-token
string
header
required

Organization API token. Generate from Organization Settings → API Tokens.

Path Parameters

orgId
string
required

Your organization ID. Any other organization returns 404.

Body

application/json
mediaItemIds
string<uuid>[]
required

Videos / clips from List videos, in course order.

Required array length: 1 - 10 elements
title
string

Course title. Defaults to the video's title when there is one video.

Maximum string length: 255
audience
string

Who the course is for. Shapes the writing; it does not decide who is assigned.

Maximum string length: 500
certification
boolean

Add a certification earned by completing every lesson.

validityMonths
integer

How long the certification lasts. Omit for never expires.

Required range: 1 <= x <= 120
questionTypes
enum<string>[]

Default multiple_choice, true_false, multi_select.

Available options:
multiple_choice,
true_false,
short_answer,
multi_select,
ordering,
matching,
numeric
checkpointsPerLesson
integer

Questions that pause the video, per lesson. Default 2.

Required range: 0 <= x <= 3
quizQuestions
integer

Final quiz questions per lesson. Default 4.

Required range: 1 <= x <= 10
maxLessonsPerVideo
integer

Upper bound on lessons from one long video, default 8. Exceeded only when fewer lessons would each run past 10 minutes.

Required range: 1 <= x <= 12

Response

Queued.

payload
object