Your library is the set of lessons your students open from your app: your syllabus, recorded once in your tutor’s name and approved by your teachers before any student sees it. This guide covers how it is arranged, the file you upload to fill it, and how review works.
How the library is arranged
- Folders follow your syllabus: subject, chapter, topic, or any levels you like, up to 8 deep. Students never see the folders; they open lessons from your app.
- Lessons are what a student opens. Each has a Lesson ID that you choose, like
concave-mirror-images: 2 to 80 lowercase letters, digits and hyphens. Your app launches a lesson by its Lesson ID. - Recordings are the prepared versions of a lesson. A lesson can have one recording per language, depth, difficulty and (optionally) delivery; each such combination is called a variant. A lesson in Hindi and English, at two depths, has four recordings.
- Only an approved recording reaches students. A new recording waits in To review until someone on your team approves it.
In the console, the Library page has these tabs: To review (recordings waiting for you), Lessons (the folder tree and every lesson), Material (your PDFs and notes, once SketchMind turns material on; see Sources), Needs attention (failed recordings and lessons students asked for) and Add lessons (upload a file or add one lesson; owners and admins, on a laptop or larger screen).
Arranging folders and lessons
Owners and admins arrange the library on the Lessons tab, on a screen at least 768 pixels wide:
- New folder, Rename, Move to… and Move up / Move down. Titles take any language, up to 120 characters.
- Renaming a folder never changes its address, the
pathyour upload file uses. A folder you renamed keeps your name even if a later file names it differently. - Archive a folder once no lesson is left below it; hidden lessons count, so move them out first. Archived folders lists them, with Bring back.
- Move up to 100 lessons at a time into a folder, or out of every folder.
- Nothing you arrange records anything again. Moving, renaming, reordering and archiving only change where lessons sit.
On a lesson’s own page you can:
- Edit lesson: its title, exam tags, brief (what it should cover) and, for a question, its answer key. A free preview lists each change and how many recordings it would make again before you save.
- In Lesson settings, choose the recording a launch starts in when it names none, and whether a launch may play the nearest recording when the exact one is missing.
A hidden lesson cannot be launched. If students asked for one, Needs attention offers Show it.
One person changes the library at a time. If someone else is saving a change or an upload, yours is not saved: the console asks you to try again in a minute (through the API, 409 library_busy with a Retry-After).
Download library as a file (every role) gives you your whole library in the upload format. Uploaded back unchanged, it changes nothing and records nothing again, except that it retries recordings that failed or were never made. That makes it the safest starting point for a bulk edit.
The upload file
The upload file is a spreadsheet saved as CSV: one header row, then one row per lesson. Upload it on Library › Add lessons, or send it to POST /v1/library/import.
path,folder_titles,slug,title,shape,brief,languages,depths,difficulties,exam_tags,sources,answer_key
optics/mirrors,Optics|Mirrors,concave-mirror-images,Images in a concave mirror,topic,"Where the image forms for each object position, with ray diagrams",English (India);Hindi,balanced,standard,JEE Main;Class 10 Boards,https://youtu.be/AAAAAAAAAAA,
optics/mirrors,,mirror-formula-sign,Signs in the mirror formula,question,"A concave mirror has f = -15 cm. Is the focal length negative? Why?",English (India),quick,standard,,,"Yes: distances measured against the incoming light are negative"Rules for the whole file
- Column names are exact, in lowercase as listed below. An unknown or misspelt column refuses the whole file, so a typo cannot slip through.
slugandtitleare required; every other column is optional.- At most 500 rows per upload. A file that would start more than 2,000 recordings is refused whole.
- Lists in one cell are separated by
;(for exampleEnglish (India);Hindi). |separates the levels offolder_titlesand the parts of avariantsitem.- A cell with a comma in it goes in double quotes, as spreadsheets save it.
- For a lesson already in your library, an empty cell keeps what the lesson has. A cell that is exactly
-clearsbrief,answer_key,exam_tagsorsources; in any other column it refuses the row. For a new lesson both mean “none”.
The columns
| Column | What goes in it |
|---|---|
slug | The Lesson ID: 2 to 80 lowercase letters, digits and hyphens. A Lesson ID already in your library updates that lesson. |
title | The lesson’s name, as students see it. |
path | The folder, as lowercase words joined by /, like optics/mirrors. At most 8 levels. A new lesson is placed there; an existing lesson stays where it is unless you tick Also move existing lessons to this file’s folders. |
folder_titles | Optional real names for each level of path, separated by |, like Optics|Mirrors. Used for new folders and for folders you have not renamed in the console. |
shape | The kind of lesson: topic (a whole topic, planned into parts; the default), subtopic (one concept, taught straight away) or question (one question explained, ending on a check question). one_liner is accepted and recorded as a topic. |
brief | What the lesson should cover, in a sentence or two. For a question, the question as your students read it, options included. |
languages | The languages to record, separated by ;. A language name such as English (India), Hinglish or Hindi, a short id or a locale tag. Default English (India). A language we do not teach in your environment refuses the row and names the ones we do. |
depths | quick (the essentials), balanced (the usual lesson; the default) or thorough (every detail). |
difficulties | gentle (for beginners), standard (for most students; the default) or challenge (for your strongest students). |
deliveries | Optional, how directly the lesson opens: anchored (on a familiar example), lean (to the point within a sentence or two) or direct (the idea in the first sentence). Leave it empty and the lesson is recorded the lean way; launches that name no delivery still find it. |
exam_tags | Exam names, separated by ;. |
sources | Up to three, separated by ;: links to single YouTube videos, or Material IDs from your Material page. See Sources. |
answer_key | For question lessons only: the correct answer. The explanation teaches toward it, and students never see it as a title. |
variants | Written by Download library as a file for a lesson whose recordings are not a full grid. Leave it empty in your own files. |
The singular spellings language, depth, difficulty and delivery are accepted too. A YouTube link in sources must point to one video (youtube.com/watch?v=…, a Short, or youtu.be/…), over https. Channels, playlists, files and other websites refuse the row with a sentence saying why.
How a row becomes recordings
Each row makes one recording for every combination of its languages, depths and difficulties, and of its deliveries when it names any. The first example row above makes two recordings: English (India) and Hindi, each balanced and standard. A new lesson with none of these columns filled gets one recording in English (India), balanced, standard. For a lesson already in your library, leaving them all empty keeps its recordings as they are; a file never removes a recording.
The free check, then confirm
Every upload starts with a free check that changes nothing. It lists:
- the rows accepted, and the rows rejected with a sentence saying what to fix;
- the recordings the upload would start, and how many already exist or are being made;
- the folders it would make, the lessons it would move (only with the tick) and every field it would change.
Fix the rejected rows and check again until the list says what you mean. Then confirm. The confirm repeats the check’s five counts:
| Count | What it counts |
|---|---|
jobs | New recordings to start. |
rerecords | Recordings to make again, because a lesson’s content changed. |
takenOff | Recordings waiting for review or not yet sent that the new ones replace. |
moves | Existing lessons moved to another folder (only with the tick). |
changes | Existing lessons with a field changed. |
The counts rule: if the library changed since your check and the file would now do more than any of those counts, the confirm writes nothing and answers plan_changed with the new counts. Run the check again and confirm what it says. The same or fewer is fine, and goes ahead.
Uploading the same file again starts nothing new. Through the API, a confirm must send the check’s counts back in expect; see Upload a library file.
Recordings are made after the confirm, a few at a time. The check estimates how long until they are ready. A recording that fails shows on the Needs attention tab; Try again, or Record what’s missing, starts it again, and so does uploading the same file.
What records again
| You change | Records again? |
|---|---|
A lesson’s brief | Yes, every recording of the lesson |
A lesson’s sources (links or material) | Yes |
A lesson’s shape | Yes |
A question lesson’s answer_key | Yes |
| The material attached to a folder | Yes, every lesson below it (see Sources) |
A lesson’s title or exam_tags | No |
| Moving, renaming, reordering or archiving folders and lessons | No |
When a lesson records again, its recordings waiting for review are taken off and replaced, and its approved recordings keep playing until the new ones are approved. Students never meet a gap.
Review and approve
New recordings wait on To review, oldest first. Owners, admins and reviewers can approve; everyone in your team can watch.
Watch before you approve
Watch opens the recording in a new tab, exactly as students will see it, in your tutor’s name and colours:
- play, pause, step back and forward, change the speed, and jump to any topic, line or check question;
- see each check question with its answer, and for a question lesson your answer key (“From your upload. Students never see it.”);
- see which steps came from your material and which are the tutor’s own words, and open the cited page (see Sources).
Watching counts nothing: no lesson, no statement line, no webhook, no limit. Open the Watch tab within five minutes of pressing the button; it then stays open for four hours, and reloading keeps your place. If it ends, press Watch again. Each person can press Watch 10 times a minute and 200 times a day.
The verdicts
| Action | What it does |
|---|---|
| Approve | The recording can now play to students. Notes are optional. The dialog shows “Not watched” or “Watched N%”: the share your own Watch tab reported. It is a guide, not proof, and never blocks approval. |
| Reject | Notes are required. Students won’t get it. Tick Record it again if you want a new recording made; otherwise nothing is recorded. |
| Take off | Stops an approved recording from playing. Lessons already running finish. |
| Keep this one playing | Keeps one approved recording playing for its variant even after a newer one is approved. Play the newest instead undoes it. |
Notes go into the lesson’s history and Activity; never put an email address or phone number in them. Each lesson page shows every recording with who reviewed it and their notes.
The Needs attention tab
- Failed recordings that need another try.
- Students asked for these: library launches in the last 30 days that found no lesson, or no recording in the language asked for. It is the quickest way to see what to record next.
Through the API
Your server can do the same with a key that has the library scope: read the folders and lessons (GET /v1/library; a large library can be read a page at a time, searched by title or Lesson ID, and narrowed to one folder or one status), upload a file (POST /v1/library/import) and follow its recordings (GET /v1/library/batches/{batchId}). Arranging folders, reviewing and approving happen in the console only. Each route is in the API reference.