Grimmory
Overview
Grimmory API v3.2.1
Section titled “Grimmory API v3.2.1”[!warning] This documentation is auto-generated and public, but the API is unstable; to join the conversation around changes to the API, visit our GitHub or Discord.
REST API documentation for managing libraries, readers, metadata, and device integrations in Grimmory.
Information
- License: AGPL-3.0
- OpenAPI version:
3.1.0
Operations
Section titled “ Operations ”POST
/api/v1/bookmarks GET
/api/v1/path POST
/api/v1/book-notes DELETE
/api/v1/book-notes/{noteId} DELETE
/api/metadata/tasks/{taskId} GET
/api/v1/authors DELETE
/api/v1/authors POST
/api/v1/books/status GET
/api/v1/books DELETE
/api/v1/books GET
/api/v1/notebook POST
/api/magic-shelves DELETE
/api/magic-shelves/{id} POST
/api/v1/email/book DELETE
/api/v1/reviews/{id} POST
/api/v1/files/move POST
/api/v1/auth/refresh POST
/api/v1/auth/logout POST
/api/v1/auth/login POST
/api/v1/files/upload POST
/api/kobo/{token}/** DELETE
/api/kobo/{token}/** PATCH
/api/kobo/{token}/** GET
/api/kobo/{token}/v1/books/{imageId}/thumbnail/{width}/{height}/{quality}/{isGreyscale}/image.jpg GET
/api/kobo/{token}/v1/books/{imageId}/{version}/thumbnail/{width}/{height}/{isGreyscale}/image.jpg POST
/api/v1/annotations POST
/api/v1/setup DELETE
/api/v1/users/{id} GET
/api/v1/users GET
/api/v1/users/me POST
/api/v2/opds-users DELETE
/api/v2/opds-users/{id} PATCH
/api/v2/opds-users/{id} GET
/api/v1/settings PUT
/api/v1/settings POST
/api/v1/libraries GET
/api/v1/version GET
/api/v1/icons POST
/api/v1/icons POST
/api/v1/icons/batch DELETE
/api/v1/icons/{svgName} POST
/api/v1/tasks/start GET
/api/v1/tasks DELETE
/api/v1/email/providers/{id} DELETE
/api/v1/shelves/{shelfId} GET
/api/v1/shelves POST
/api/v1/shelves GET
/api/v1/opds DELETE
/api/v2/book-notes/{noteId} POST
/api/v2/book-notes © 2026 Grimmory