Course Lesson - Whop Docs

{
	"assessment_questions": [
		{
			"correct_answer": "<string>",
			"created_at": "2023-12-01T05:00:00.401Z",
			"id": "crsaq_xxxxxxxxxxxx",
			"image": {
				"content_type": "image/jpeg",
				"filename": "document.pdf",
				"id": "<string>",
				"url": "https://media.whop.com/abc123/optimized.jpg"
			},
			"options": [
				{
					"id": "crsaqo_xxxxxxxxxxx",
					"is_correct": true,
					"option_text": "<string>",
					"order": 42
				}
			],
			"order": 42,
			"question_text": "<string>",
			"question_type": "short_answer"
		}
	],
	"attachments": [
		{
			"content_type": "image/jpeg",
			"filename": "document.pdf",
			"id": "<string>",
			"url": "https://media.whop.com/abc123/optimized.jpg"
		}
	],
	"content": "In this lesson, we will cover the basics of technical analysis...",
	"created_at": "2023-12-01T05:00:00.401Z",
	"days_from_course_start_until_unlock": 42,
	"embed_id": "dQw4w9WgXcQ",
	"embed_type": "youtube",
	"id": "lesn_xxxxxxxxxxxxx",
	"lesson_type": "text",
	"main_pdf": {
		"content_type": "image/jpeg",
		"filename": "document.pdf",
		"id": "<string>",
		"url": "https://media.whop.com/abc123/optimized.jpg"
	},
	"order": 42,
	"thumbnail": {
		"url": "https://media.whop.com/abc123/optimized.jpg"
	},
	"title": "Understanding Candlestick Patterns",
	"video_asset": {
		"asset_id": "<string>",
		"audio_only": true,
		"created_at": "2023-12-01T05:00:00.401Z",
		"duration_seconds": 42,
		"finished_uploading_at": "2023-12-01T05:00:00.401Z",
		"id": "mux_xxxxxxxxxxxxxx",
		"playback_id": "<string>",
		"signed_playback_id": "<string>",
		"signed_storyboard_playback_token": "<string>",
		"signed_thumbnail_playback_token": "<string>",
		"signed_video_playback_token": "<string>",
		"status": "uploading",
		"updated_at": "2023-12-01T05:00:00.401Z"
	},
	"visibility": "visible"
}

{
	"assessment_questions": [
		{
			"correct_answer": "<string>",
			"created_at": "2023-12-01T05:00:00.401Z",
			"id": "crsaq_xxxxxxxxxxxx",
			"image": {
				"content_type": "image/jpeg",
				"filename": "document.pdf",
				"id": "<string>",
				"url": "https://media.whop.com/abc123/optimized.jpg"
			},
			"options": [
				{
					"id": "crsaqo_xxxxxxxxxxx",
					"is_correct": true,
					"option_text": "<string>",
					"order": 42
				}
			],
			"order": 42,
			"question_text": "<string>",
			"question_type": "short_answer"
		}
	],
	"attachments": [
		{
			"content_type": "image/jpeg",
			"filename": "document.pdf",
			"id": "<string>",
			"url": "https://media.whop.com/abc123/optimized.jpg"
		}
	],
	"content": "In this lesson, we will cover the basics of technical analysis...",
	"created_at": "2023-12-01T05:00:00.401Z",
	"days_from_course_start_until_unlock": 42,
	"embed_id": "dQw4w9WgXcQ",
	"embed_type": "youtube",
	"id": "lesn_xxxxxxxxxxxxx",
	"lesson_type": "text",
	"main_pdf": {
		"content_type": "image/jpeg",
		"filename": "document.pdf",
		"id": "<string>",
		"url": "https://media.whop.com/abc123/optimized.jpg"
	},
	"order": 42,
	"thumbnail": {
		"url": "https://media.whop.com/abc123/optimized.jpg"
	},
	"title": "Understanding Candlestick Patterns",
	"video_asset": {
		"asset_id": "<string>",
		"audio_only": true,
		"created_at": "2023-12-01T05:00:00.401Z",
		"duration_seconds": 42,
		"finished_uploading_at": "2023-12-01T05:00:00.401Z",
		"id": "mux_xxxxxxxxxxxxxx",
		"playback_id": "<string>",
		"signed_playback_id": "<string>",
		"signed_storyboard_playback_token": "<string>",
		"signed_thumbnail_playback_token": "<string>",
		"signed_video_playback_token": "<string>",
		"status": "uploading",
		"updated_at": "2023-12-01T05:00:00.401Z"
	},
	"visibility": "visible"
}

assessment_questions

array<object>

required

The list of questions for quiz or knowledge check lessons. Empty for non-assessment lesson types.

Show child attributes

correct_answer

string | null

required

The correct answer for the question. Used for short answer questions. Only visible to admins (users with courses:update permission)

created_at

string<date-time>

required

The datetime the assessment question was created.Example: 2023-12-01T05:00:00.401Z

string

required

The unique identifier for the assessment question.Example: crsaq_xxxxxxxxxxxx

image

object | null

required

Optional image attachment for the question

Show child attributes

content_type

string | null

required

The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).Example: image/jpeg

filename

string | null

required

The original filename of the uploaded attachment, including its file extension.Example: document.pdf

string

required

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

url

string | null

required

A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.Example: https://media.whop.com/abc123/optimized.jpg

options

array<object>

required

The answer options for multiple choice/select questions

Show child attributes

string

required

The unique identifier for the assessment question option.Example: crsaqo_xxxxxxxxxxx

is_correct

boolean | null

required

Whether this option is a correct answer. Only visible to admins (users with courses:update permission)

option_text

string

required

The text of the answer option

order

integer

required

The order of this option within the questionExample: 42

order

integer

required

The order of the question within its lessonExample: 42

question_text

string

required

The text of the question

question_type

CoursesAssessmentQuestionTypes

required

The type of the questionAvailable options: short_answer, true_false, multiple_choice, multiple_select

attachments

array<object>

required

All supplementary files attached to this lesson returned as a flat array rather than a paginated connection.

Show child attributes

content_type

string | null

required

The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).Example: image/jpeg

filename

string | null

required

The original filename of the uploaded attachment, including its file extension.Example: document.pdf

string

required

url

string | null

required

A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.Example: https://media.whop.com/abc123/optimized.jpg

content

string | null

required

The Markdown content body of the lesson. Null if the lesson has no text content.Example: In this lesson, we will cover the basics of technical ana…

created_at

string<date-time>

required

The datetime the lesson was created.Example: 2023-12-01T05:00:00.401Z

days_from_course_start_until_unlock

integer | null

required

The number of days after a student starts the course before this lesson becomes accessible. Null if the lesson is available immediately.Example: 42

embed_id

string | null

required

The external video identifier for embedded video lessons, such as a YouTube video ID or Loom share ID. Null if the lesson has no embed.Example: dQw4w9WgXcQ

embed_type

EmbedTypes | null

required

The platform type for the embedded video. One of: youtube, loom. Null if the lesson has no embed.Available options: youtube, loom

string

required

The unique identifier for the lesson.Example: lesn_xxxxxxxxxxxxx

lesson_type

LessonTypes

required

The content format of this lesson. One of: text, video, pdf, multi, quiz, knowledge_check.Available options: text, video, pdf, multi, quiz, knowledge_check

main_pdf

object | null

required

The primary PDF document for PDF-type lessons. Null if this lesson is not a PDF lesson or no PDF has been uploaded.

Show child attributes

content_type

string | null

required

The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).Example: image/jpeg

filename

string | null

required

The original filename of the uploaded attachment, including its file extension.Example: document.pdf

string

required

url

string | null

required

A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.Example: https://media.whop.com/abc123/optimized.jpg

order

integer

required

The sort position of this lesson within its parent chapter, starting from zero.Example: 42

thumbnail

object | null

required

The thumbnail image displayed on lesson cards and previews. Null if no thumbnail has been uploaded.

Show child attributes

url

string | null

required

A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.Example: https://media.whop.com/abc123/optimized.jpg

title

string

required

The display name of the lesson shown to students. Maximum 120 characters.Example: Understanding Candlestick Patterns

video_asset

object | null

required

The Mux video asset for video-type lessons, used for streaming playback. Null if this lesson has no hosted video.

Show child attributes

asset_id

string | null

required

The Mux-provided ID of the asset

audio_only

boolean

required

Whether this asset contains only audio

created_at

string<date-time>

required

The datetime the mux asset was created.Example: 2023-12-01T05:00:00.401Z

duration_seconds

integer | null

required

The duration of the video in secondsExample: 42

finished_uploading_at

string<date-time> | null

required

The time at which the video finished uploadingExample: 2023-12-01T05:00:00.401Z

string

required

The unique identifier for the mux asset.Example: mux_xxxxxxxxxxxxxx

playback_id

string | null

required

The public playback ID of the Mux asset

signed_playback_id

string | null

required

The signed playback ID of the Mux asset

signed_storyboard_playback_token

string | null

required

The signed storyboard playback token of the Mux asset

signed_thumbnail_playback_token

string | null

required

The signed thumbnail playback token of the Mux asset

signed_video_playback_token

string | null

required

The signed video playback token of the Mux asset

status

MuxAssetStatuses

required

The status of the Mux assetAvailable options: uploading, created, ready

updated_at

string<date-time>

required

The datetime the mux asset was last updated.Example: 2023-12-01T05:00:00.401Z

visibility

LessonVisibilities

required

The visibility setting that controls whether this lesson appears to students. One of: visible, hidden.Available options: visible, hidden

Courselessoninteraction completed

List course lessons

⌘I