Skip to content
Savorum API
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Guides
Get started
Events, webhooks, and jobs
Native app sign-in
HTTP API
Overview
Libraries
Overview
Create a library
Delete a library
List libraries
Recipes
Overview
Check a source URL
Create a recipe
Delete a trashed recipe
Empty the trash
Get a recipe
Get a recipe revision
Get a trashed recipe
Link a recipe as a translation
List a recipe's translations
List import events
List recipe references
List recipe revisions
List recipes
Move a recipe to trash
Read an ingredient line
Reanalyze microwave timings
Replace a recipe
Resolve recipes selections
Restore a recipe from trash
Restore a recipe revision
Save a new translation
Start a translation
Suggest recipes
Unlink a translation
Recipe authors
Overview
Find recipe authors
Plan
Overview
Copy a meal
Create a calendar feed
Delete a meal
Delete a reusable meal
Download the plan as iCalendar
Get a meal
Get a reusable meal
List calendar feeds
List meals
List reusable meals
Plan a meal
Plan a reusable meal
Replace a calendar feed's URL
Replace a meal
Replace a reusable meal
Revoke a calendar feed
Save a reusable meal
Suggest saved meals
Shopping
Overview
Add groceries atomically
Apply a retryable grocery edit
Apply grocery choices
Create a named shopping list
Delete a named shopping list
List household shopping lists
List shopping list activity
Read the shared grocery list
Rename a shopping list
Review grocery requirements
Organization
Overview
Get recipe organization
Replace recipe organization
Cooking history
Overview
Delete a cooking
List cookings
Record a cooking
Replace a cooking
Books
Overview
Create a book
Delete a trashed book
Get a book
Get a book revision
Get a trashed book
List book revisions
List books
List sourced recipes
Move a book to trash
Replace a book
Resolve books selections
Restore a book from trash
Restore a book revision
Suggest books
Tags
Overview
Create a tag
Delete a tag
Get a tag
List tags
Merge a tag
Replace a tag
Facets
Overview
Create a facet
Delete a facet
Get a facet
List facets
Merge a facet
Replace a facet
Saved views
Overview
Create a saved view
Delete a saved view
Get a saved view
List saved view recipes
List saved views
Replace a saved view
Assets
Overview
Get a book asset
Get a book asset derivative
Get a recipe asset
Get a recipe asset derivative
Head a book asset
Head a recipe asset
Upload an asset
Import
Overview
Apply a measurement plan
Cancel an import preview
Commit an import preview
Create a measurement plan
Create an import preview
Delete a measurement plan
Get a measurement group
Get a preview item image
Get an import preview
Import a web page
Import an SREF package
Import SREF documents
Import third-party exports
Preview a web page
Update preview item text
Import jobs
Overview
Cancel an import job
Get an import job
List import job items
List import jobs
Resume an import job
Start an import job
Export
Overview
Export a book bundle
Export a recipe
Export a recipe revision
Export a selection bundle
Head a book bundle export
Head a recipe export
Head a recipe revision export
Head a selection bundle export
Print
Overview
Create a print document
Get a print document
Head a print document
Account
Overview
Change the password
Delete the current account
Get preferences
Get the current account
List audit events
Replace preferences
Select a library
Sessions
Overview
List sessions
Revoke a session
Revoke other sessions
Sign in
Sign out
Passkeys
Overview
Begin passkey registration
Begin passkey sign-in
Finish passkey registration
Finish passkey sign-in
List passkeys
Rename a passkey
Revoke a passkey
Recovery codes
Overview
Generate recovery codes
Get recovery status
Sign in with a recovery code
API tokens
Overview
Create an API token
List API tokens
Revoke an API token
Library members
Overview
List library members
Recover library ownership
Remove a library member
Set a library member
Invitations
Overview
Accept an invitation
Create an invitation
List invitations
Register from an invitation
Revoke an invitation
Sign-in methods
Overview
Force-unlink a sign-in method
List a user's sign-in methods
List provider dependencies
List sign-in methods
Unlink a sign-in method
Authentication
Overview
Begin a native sign-in
Begin a provider sign-in
Complete a SAML sign-in
Complete browser sign-in
Finish a native link
Finish a native sign-in
Get SAML metadata
List group mappings
List sign-in providers
Open a managed library
Redeem a managed session grant
Remove a group mapping
Set a group mapping
Start a native link
Users
Overview
Create a user
List users
Update a user
Webhooks
Overview
Create instance webhook
Create library webhook
Delete instance webhook
Delete library webhook
List instance deliveries
List instance webhooks
List library deliveries
List library webhooks
Read instance delivery
Read instance webhook
Read library delivery
Read library webhook
Retry instance delivery
Retry library delivery
Rotate instance key
Rotate library key
Test instance webhook
Test library webhook
Update instance webhook
Update library webhook
Events
Overview
Follow library changes
Bulk
Overview
Bulk book recipes
Bulk read recipes
Bulk restore recipes
Bulk tags recipes
Bulk trash recipes
Jobs
Overview
Cancel unfinished work
Commit a frozen import
Download an export artifact
Queue an export
Queue an import preview
Read a bulk or transfer job
Read a frozen import preview
Read job item results
Resume interrupted work
Pantry
Overview
Read pantry presence
Remove a pantry hint
Save pantry presence
Instance
Overview
Check health
Discover capabilities
Get instance configuration
Observe storage capacity
Select theme
Dark
Light
Auto
Overview
Assets
Section titled “Assets”
Immutable content-addressed uploads and their delivery.
Operations
Section titled “Operations”
GET
/api/v1/books/{book_id}/assets/{id}
GET
/api/v1/books/{book_id}/assets/{id}/derivatives/{preset}
GET
/api/v1/recipes/{recipe_id}/assets/{id}
GET
/api/v1/recipes/{recipe_id}/assets/{id}/derivatives/{preset}
HEAD
/api/v1/books/{book_id}/assets/{id}
HEAD
/api/v1/recipes/{recipe_id}/assets/{id}
POST
/api/v1/assets