Studies

Create a new Study

Create a study, and a new empty chapter within it. You can make up to 30 new studies per day.

post/api/study

Request

Base URL
https://lichess.org
URL
https://lichess.org/api/study
Auth
OAuth 2
Authorization code: https://lichess.org/oauth
Token URL: https://lichess.org/api/token scopes: study:write

namestring required

The study name.

visibility'public' | 'unlisted' | 'private' required

Who can view the study.

public: Default. Anyone can view the study, it appears on public listings
unlisted: Only people with the link can view the study, it doesn't appear on public listings
private: Only the study members can view the study

flairstring

computer'nobody' | 'owner' | 'contributor' | 'member' | 'everyone' required

explorer'nobody' | 'owner' | 'contributor' | 'member' | 'everyone' required

cloneable'nobody' | 'owner' | 'contributor' | 'member' | 'everyone' required

shareable'nobody' | 'owner' | 'contributor' | 'member' | 'everyone' required

chat'nobody' | 'owner' | 'contributor' | 'member' | 'everyone' required

stickyboolean

Keep everyone on the same chapter and position.

descriptionboolean

Add pinned study comment right under the board.

The Study has been successfully created.

idstring