Learn how to upload and sell ebooks on Fermion

Ebooks

Fermion Documentation

Learn about Fermion and how it helps businesses, academies, and creators build their online learning platforms

What is Fermion?

Learn how Fermion compares to other learning management platforms

Fermion vs other platforms

Explore the features and capabilities of Fermion for businesses, academies, and creators

What can you do on Fermion?

Before you start building your course

Setting up course landing page

Managing the course syllabus

How to bulk import syllabus?

How to add files to course items?

Managing course analytics

Frequently asked questions

Setup fixed pricing plan

Setup partial payment pricing plan

Coupon codes

What are coding labs?

Learn how to configure coding labs using the .cdmrc configuration file

Using .cdmrc

How to embed a coding lab?

How to create interactive HTML/CSS labs?

How to create an interactive React.js lab with Vitest?

How to create a Rust Lab?

How to create a Java lab with JUnit?

How to create an interactive Python lab with Pytest?

What is content library?

Learn about IO coding labs and supported programming languages on Fermion

IO coding labs introduction

How to embed IO coding lab?

Live classes on Fermion

Creating a live class

Learn how to integrate Fermion live sessions into your website using the SDK or manual iframe embedding, with support for both instructor WebRTC mode and student view-only mode.

How to embed a live session externally

Common questions regarding live classes on Fermion

Frequently Asked Questions

Learn how to upload and manage recorded videos on Fermion

Introduction

Learn how to integrate Fermion recorded videos into your website using our SDK, including public and private video embedding options.

How to embed a video externally

How to embed an ebook externally

What are communities on Fermion?

Learn how to create high-converting, fully customizable landing pages on Fermion using no-code tools or your own source code.

Creating a Custom Landing Page on Fermion

Using WordPress

Using source code for custom pages

Understand how to construct direct checkout page links using Fermion

Direct checkout page links

Custom redirects

Affiliate system for your online academy

Using webhooks

Email automation

Changing your School Settings

Change Instructor Details

How do you get Paid?

How can you resolve your doubts?

Increment the XP of a given user by the given amount.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Add XP to user 

Get leaderboard of the top ranking users in your school

Rate limit: Maximum 60 requests in a window of 1m.

Get leaderboard 

Get XP of a user

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get user XP 

Decrement the XP of a given user by the given amount.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Remove XP from user 

Creates a new interactive coding lab with API. You can use this endpoint instead of creating it from GUI in fermion dashboard

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Create new interactive coding lab 

Deletes an existing interactive coding lab.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Delete interactive coding lab 

Get details of multiple interactive labs from their IDs

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get interactive lab details [bulk] 

Get details of a single interactive lab from its ID

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get interactive lab details [single] 

Get a list of all interactive labs from the school's private library

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

List all interactive labs 

Get result of a single user for a given I/O lab

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get Lab result (I/O lab) 

Get result of a single user for a given interactive lab

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get Lab result (interactive lab) 

Updates an existing interactive coding lab with API. You can use this endpoint instead of updating it from GUI in fermion dashboard

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Update interactive coding lab 

Create a new live event session that you can use to go live

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Create live session 

Call this to end live event streaming and finalize the video. After you call this, the only possible playback mode with livestreaming would be HLS playback

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

End live event streaming 

Get details of all live events in your school

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 15 requests in a window of 1m.

Get all live events 

Get url to download captions for a live event session

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get live event session caption 

Get url to download processed mp4 for a live event session

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get live event session processed mp4 

Get stream and viewer stats for a live event session

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get live event session stats 

Add or remove people from webrtc meeting stage. This will make the user a participant or instructor in a given live stream. Use this API to make certain user(s) instructors before the stream starts.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Modify live session user state 

Call this to begin live event streaming. After you call this, your instructors can join the meeting area

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Start live event streaming 

Create a new user in the system using the unique userId from your database. Note that this function is idempotent, therefore, calling it multiple times with the same userId will not do anything.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Create new user 

Get URL to upload a user's profile photo. You have to make a PUT request on the "presignedUrl" to upload the picture, then call the "update-user-profile-data" api endpoint to set the user's profile picture url to the "regularUrl" returned by this resolver.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get presigned URLs to upload user profile picture 

Get basic user data like name, profile photo url, username, etc. using this resolver.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get user basic profile data 

Get detailed user data like user activities, xp, enrollments, etc. using this resolver.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get user detailed analytics data 

Update user data like name, profile photo url, username, etc. using this resolver. Useful for using built-in services like coding labs and live classes

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Update user profile data 

Call this endpoint to delete a video from the system. This operation cannot be undone.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Delete Video 

Get URL to upload a video in your school. You have to make a PUT request on the "presignedUrl" to upload the video, then call the "start-processing-uploaded-video" API endpoint for our transcoder to start processing your uploaded video.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get presigned URL to upload video 

Get m3u8 playlist URL, decryption key and verification URL signatures for playing a Fermion live event manually. This is recommended for advanced use cases only

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get signed URL data for live event session 

Get m3u8 playlist URL, decryption key and verification URL signatures for playing a Fermion video manually. This is recommended for advanced use cases only

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get signed URL data for recorded videos 

Call this endpoint after "get-presigned-url-for-video-upload" endpoint for our system to start processing your uploaded video. Note that you must wait for upload of video to finish otherwise your video processing might fail.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Start processing uploaded video 

Use this endpoint to update whether video can be played publicly, or if it requires a JWT to be played. Read more about it here: https://docs.fermion.app/docs/recorded-videos/embed-video

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Update video privacy setting 

Add a user enrollment into any digital product on your website

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Enroll user into digital product 

Get details of all published digital products with this API

Rate limit: Maximum 15 requests in a window of 1m.

Get published digital products 

Get price of a single digital product depending on the country of user requesting it

Rate limit: Maximum 60 requests in a window of 1m.

Get localized digital product price 

Get details of all enrolled digital products for a given user

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 15 requests in a window of 1m.

Get enrolled digital products 

Get details of all published blogs with this API

Rate limit: Maximum 15 requests in a window of 1m.

Get published blogs 

Get details of a single blog with this API endpoint

Rate limit: Maximum 15 requests in a window of 1m.

Get blog information 

Get details of all published courses with this API

Rate limit: Maximum 15 requests in a window of 1m.

Get published courses 

Get ID of a course from its slug

Rate limit: Maximum 15 requests in a window of 1m.

Get course ID from course slug 

Get all the data for a given course item. Note that this is a sensitive action and will return data for draft/unpublished course items as well.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get data for a given course item 

Get detailed metadata of a specific course using its slug

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get course metadata by slug 

Get price of a single course depending on the country of user requesting it

Rate limit: Maximum 60 requests in a window of 1m.

Get localized course price 

Get published course items for an individual course

Rate limit: Maximum 15 requests in a window of 1m.

List course items 

Get result of a course item for a given user

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get user course item result 

Submit a course item for a given user

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Submit user course item 

Get a list of all quizzes from the school's private library

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

List all quizzes 

Get details of a quiz from its ID

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get quiz details 

Get result of multiple DSA code execution attempts at once

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 6000 requests in a window of 1m.

Get DSA code execution result [batch] 

Get result of a single DSA code execution attempt

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 300 requests in a window of 1m.

Get DSA code execution result [single] 

Request multiple DSA code executions at once. Please note that if you are running SQLite, you must pass `additionalFilesAsZip` as a ZIP file that must contain `db.sqlite` file (exact name) when unzipped

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 10000 requests in a window of 1m.

Request DSA code execution [batch] 

Request a single DSA code execution. Please note that if you are running SQLite, you must pass `additionalFilesAsZip` as a ZIP file that must contain `db.sqlite` file (exact name) when unzipped.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 5000 requests in a window of 1m.

Request DSA code execution [single] 

Get all courses progress of a given user. Use this to get their progress and completion data.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 300 requests in a window of 1m.

Get all courses progress of a given user 

Get user course bundle progress for all bundles. Use this to get their progress and completion data.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get user course bundle progress for all bundles 

Get user course bundle progress. Use this to get their progress and completion data.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get user course bundle progress for specific bundle 

Get individual user course progress. Use this to get their progress and completion data.

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Get individual user course progress 

Health check for our internal system

Rate limit: Maximum 60 requests in a window of 1m.

Health check 

Test endpoint to check your fermion API key

Authentication with the "FERMION-API-KEY" header is required to use this endpoint.

Rate limit: Maximum 60 requests in a window of 1m.

Getting Started

Setting up a course

Setup pricing

Creating coding labs

Creating IO coding labs

Live classes

Recorded videos

Ebooks

Community

Custom pages

Marketing Tools

Manage Settings

Ebooks