Full-text search across shelves, books, chapters and pages. Returns matches with [type:id] refs, their location and a text snippet. BookStack search syntax works in query: "exact phrase", [tag] or [tag=value], {in_name:word}, {updated_by:me}, {created_by:me}.

List shelves, books, chapters or pages. Use it to see what exists (e.g. all books) or to find recently updated pages (sort=updated). To see what's inside a book, use get on the book instead.

Open one item by id. page → full content as Markdown plus its location. book → table of contents (chapters and pages). chapter → its pages. shelf → its books.

Create a page from Markdown, inside a chapter (chapter_id) or directly in a book (book_id). Check first that a page on this topic doesn't already exist — updating beats duplicating.

Replace a page's content, add to its end/start (mode), rename it, retag it or move it. For a small change inside an existing page prefer edit_page. WYSIWYG pages stay WYSIWYG (the Markdown is converted to HTML).

Exact find-and-replace in a page's Markdown source — the cheap way to fix or extend part of a page without resending all of it. old_text must match the source exactly (read the page with get first). Only for Markdown-editor pages; for WYSIWYG pages use update_page.

Create a book, optionally placing it on a shelf.

Create a chapter in a book. Chapters group pages and can't be nested.

Create a shelf (a group of books), optionally with books on it.

Rename a shelf/book/chapter or change its description or tags; move a chapter (with its pages) to another book; add or remove books on a shelf. For pages use update_page / edit_page.

Move a page, chapter, book or shelf to the BookStack recycle bin (restorable by an admin). Deleting a book or chapter deletes everything inside it; deleting a shelf keeps its books. Only delete when the user explicitly asked for it.