Course

{
	"certificate_after_completion_enabled": true,
	"chapters": [
		{
			"id": "chap_xxxxxxxxxxxxx",
			"lessons": [
				{
					"id": "lesn_xxxxxxxxxxxxx",
					"lesson_type": "text",
					"order": 42,
					"thumbnail": {
						"url": "https://media.whop.com/abc123/optimized.jpg"
					},
					"title": "Understanding Candlestick Patterns",
					"video_asset": {
						"duration_seconds": 42,
						"signed_playback_id": "<string>",
						"signed_thumbnail_playback_token": "<string>"
					}
				}
			],
			"order": 42,
			"title": "Getting Started"
		}
	],
	"cover_image": "https://assets.whop.com/images/course-cover.jpg",
	"created_at": "2023-12-01T05:00:00.401Z",
	"description": "Learn advanced trading strategies from industry experts.",
	"id": "cors_xxxxxxxxxxxxx",
	"language": "en",
	"order": "123.45",
	"require_completing_lessons_in_order": true,
	"tagline": "Master the fundamentals in 30 days",
	"thumbnail": {
		"content_type": "image/jpeg",
		"filename": "document.pdf",
		"id": "<string>",
		"optimized_url": "https://media.whop.com/abc123/optimized.jpg",
		"source_url": "https://media.whop.com/abc123/original.jpg"
	},
	"title": "Introduction to Technical Analysis",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"visibility": "visible"
}

boolean | null

required

Whether students receive a PDF certificate after completing all lessons in this course. Null if the setting has not been configured.

array<object>

required

An ordered list of all chapters in this course, sorted by their display position.

Show child attributes

string

required

The unique identifier for the chapter.Example: chap_xxxxxxxxxxxxx

array<object>

required

An ordered list of lessons in this chapter, sorted by display position. Hidden lessons are excluded for non-admin users.

Show child attributes

string

required

The unique identifier for the lesson.Example: lesn_xxxxxxxxxxxxx

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

integer

required

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

object | null

required

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

Show child attributes

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

string

required

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

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

integer | null

required

The duration of the video in secondsExample: 42

string | null

required

The signed playback ID of the Mux asset

string | null

required

The signed thumbnail playback token of the Mux asset

integer

required

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

string

required

The display name of the chapter shown to students. Maximum 150 characters.Example: Getting Started

string | null

required

The URL of the course cover image shown on preview cards. Null if no cover image has been uploaded.Example: https://assets.whop.com/images/course-cover.jpg

string<date-time>

required

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

string | null

required

A brief summary of the course content and objectives. Null if no description has been set.Example: Learn advanced trading strategies from industry experts.

string

required

The unique identifier for the course.Example: cors_xxxxxxxxxxxxx

Languages

required

The spoken language of the video content, used to generate accurate closed captions. One of: en, es, it, pt, de, fr, pl, ru, nl, ca, tr, sv, uk, no, fi, sk, el, cs, hr, da, ro, bg.Available options: en, es, it, pt, de, fr, pl, ru, nl, ca, tr, sv, uk, no, fi, sk, el, cs, hr, da, ro, bg

string

required

The sort position of this course within its parent experience, as a decimal for flexible ordering.Example: 123.45

boolean

required

Whether students must complete each lesson sequentially before advancing to the next one.

string | null

required

A short marketing tagline displayed beneath the course title. Null if no tagline has been set.Example: Master the fundamentals in 30 days

object | null

required

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

Show child attributes

string | null

required

Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg.Example: image/jpeg

string | null

required

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

string

required

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

string | null

required

The original source URL of the attachment, such as a direct link to S3. This should never be displayed on the client and should always be passed through an Imgproxy transformer.Example: https://media.whop.com/abc123/original.jpg

string | null

required

The display name of the course shown to students. Null if no title has been set.Example: Introduction to Technical Analysis

string<date-time>

required

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

CourseVisibilities

required

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

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats