add_blocks
ChatGPTAdd blocks to the end of an existing lesson, keeping what is already there. Refused if any student already has the lesson on their day — build a new lesson with create_lesson instead. Blocks and text work exactly as in create_lesson. Each call saves its blocks whole or not at all.
add_bookshelf_item
ChatGPTAdd a book or workbook to the School's Bookshelf, by its name, so lessons can work from it and a course can follow it. Check list_bookshelf first: if the book is already there, use its id. A name the Bookshelf already has is refused, with that item's id — including when you retry a call whose answer was lost. Answers the new item's id and name; use the id as create_course's follows, or a read or do block's work_from or see_also.
add_file
ChatGPTHand out a file your app passes as a file — one you made, such as a worksheet or a PDF, or one the guide attached — with a block of a lesson no student has on their day yet, as the builder's Files are: the student opens it beside the block. Read the lesson first with get_lesson (or use a building tool's answer) and send its version and the block's number from its outline. Any block takes up to 10 files. A document, spreadsheet, presentation, PDF, plain text, picture or audio file is accepted; a web page, a script or an archive is not. label is what the student sees beside the file; left out, they see its name. Nothing already in the lesson is replaced or removed. If someone changed the lesson since you read it, the file is refused: read it again and send its new version. If your app can't pass the file as a file, give it to the guide to add in the builder instead.
add_picture
ChatGPTAdd a picture your app passes as a file — one you made, or one the guide attached — to a lesson no student has on their day yet. Read the lesson first with get_lesson (or use a building tool's answer) and send its version and the block's number from its outline. For a Label the picture block waiting for its picture, the picture fills it, and the block keeps the description it was built with (leave alt out). For a read, do, write, memory or discuss block, the picture goes into its text with alt, what it shows for a student who can't see it: at puts it before that element of the block's text as get_lesson shows it, counted from 1 (get_lesson's notes say where the pictures already there sit); leave at out to put it at the end. Nothing already in the lesson is replaced or removed. If someone changed the lesson since you read it, the picture is refused: read it again and send its new version. If your app can't pass the picture as a file, give it to the guide to add in the builder instead.
create_course
ChatGPTStart a new, empty course in the School. Check list_courses first: a course with the same name may already exist, and adding to it may be what the guide wants. Choose the kind carefully: "standard" (the default) is a course the family's own guide teaches. To build a course around one book or workbook, set follows to its Bookshelf id (from list_bookshelf, or add it with add_bookshelf_item if it isn't on the shelf), then make its lessons with create_lessons, one per section in a single call, each read or do block working from that item (work_from, with its section and pages); a photo of the book's table of contents is a good source for the sections. "instructed" is a class taught by someone outside the family, such as a co-op teacher, a tutor or a music teacher. Name its instructor: call list_instructors first and send instructor_id, or send new_instructor with a name only when the instructor isn't there yet. If the guide says when the class meets, send meets. Ask the guide whether the class has a meeting link, such as a video call, to send as meeting_link (with an optional meeting_link_label, the word on the student's button); never make one up. "practice" is a course of practice lessons a guide plans again and again, such as piano practice or math facts; its lessons are templates. Only a standard course can follow a Bookshelf item, and only a class takes an instructor, meets or a meeting link. You can't add students to a course: the guide does that in the app, and it's what puts a class's meetings on their days. Nothing is retried for you: if a response is lost, call list_courses with the name before trying again, so you don't make the course twice.
create_lesson
ChatGPTCreate a new lesson at the end of a course, with its blocks in order. Blocks can be something to read, something to do, a writing prompt, multiple choice, matching, fill in the blanks, a spelling list (Make Homeschool speaks each word aloud for you), or a picture to label (you make the picture and give it to the guide; the block waits for it); a read or do block can work from a Bookshelf item (see list_bookshelf). Text is HTML using only p, h1–h6, ul, ol, li, blockquote, br, strong, b, em, i, s, del, strike, a, table, thead, tbody, tfoot, tr, th and td — or plain text. Attributes and style are mostly dropped, and their look isn't kept. A link's href and a list's start are kept. Attributes that change how text is read, and styles that hide text, change its direction or its list markers, are refused, and so is a style using comments, escapes, quotes or var(). The lesson reaches no student until a guide places it; share the returned review_url so the guide can look it over. Each call saves its lesson whole or not at all — but a lost response doesn't tell you which. Send a request_id (a UUID you create once per lesson) and resend the same call if you retry: you'll get back the lesson already made, as it is now, rather than a second one.
create_lessons
ChatGPTMake several lessons at once in one course, each with its own blocks, in order, all or none, such as one per section of a book's table of contents (up to 100 per call; send more in another call). Use create_lesson for a single lesson. Each lesson is {title, blocks}, exactly as create_lesson takes them; p, h1–h6, ul, ol, li, blockquote, br, strong, b, em, i, s, del, strike, a, table, thead, tbody, tfoot, tr, th and td are the HTML tags a block's text may use. Send a request_id (a UUID you make once for this batch) and resend the identical call to retry: you get back the lessons it made, in order, rather than a second set. A batch with the same request_id but other lessons, another order or changed content is refused. The batch's spelling lists speak at most 25 words in all; send more lists in another call. No lesson reaches a student until a guide places it; share each lesson's review_url so the guide can look it over.
get_lesson
ChatGPTRead one lesson's blocks in order, in exactly the shape create_lesson and add_blocks take, so you can use it as a template: change what you need and send it back. Anything the lesson holds that you can't send back (a Watch or Memory block, a picture — a Label the picture block comes back without its picture, and waits for one if sent — handed-out files, a block's own evidence setting) is named in notes. The lesson's description and review setting are not included.
list_bookshelf
ChatGPTList the School's Bookshelf: each item's id and name, in name order. Use an item's id as a Read or Do block's work_from or see_also. Takes no arguments.
list_courses
ChatGPTList the courses in this School: each course's id, name, kind (standard, instructed or practice) and how many lessons it has. Archived courses are not included. Pass name to list only the courses whose name contains it, ignoring case.
list_instructors
ChatGPTList the School's instructors — people outside the family who teach a class, such as a co-op teacher or a tutor: each one's id, name and how many courses they teach, in name order. Use an instructor's id as create_course's instructor_id. Takes no arguments.
list_lessons
ChatGPTList the lessons in one course, in order: each lesson's id, name, position, how many blocks it has, and whether it is already on a student's day (a lesson that is can't be added to — build a new one instead).
revise_lesson
ChatGPTChange a lesson no student has on their day yet: rename it, and set its blocks. Read it first with get_lesson (or use a building tool's answer) and send its version. blocks is the lesson's whole new list, in order: {"keep": N} keeps block N exactly as it is (N is the block's number in get_lesson's outline, including blocks you can't build, such as a video the guide added), and anything else is a new block in create_lesson's shape. Every block you don't keep is removed, with anything it holds, such as a file or a picture the guide added — so keep every block you aren't changing. To replace a block, leave it out and put its new version where it was. Text is HTML using only p, h1–h6, ul, ol, li, blockquote, br, strong, b, em, i, s, del, strike, a, table, thead, tbody, tfoot, tr, th and td — or plain text. A lesson on a student's day can't be changed: build a new lesson instead. A test can't be changed here. If someone changed the lesson since you read it, the change is refused: read it again and send your changes against its new version. If a response is lost, check with get_lesson before trying again — your change may already be in.