API reference
Every endpoint of the HTTP API, generated from the OpenAPI document.
Auth
Signing in, signing out and reading the current session.
Recipes
Creating, reading, updating and deleting recipes, and searching them.
Comments
Household members' comments on a recipe.
Tags
The tags recipes are filed under.
Images
Uploading recipe images and serving them in their rendered sizes.
Transfer
Exporting recipes with their photos as a zip and importing such a file. Administrators only.
Push
Devices that receive notifications: a finished cook timer, a new comment and the other notifications a member keeps on for push, and a test push.
Shares
Public links to recipes: creating, listing and revoking them. Session only.
Public
What anyone may read without signing in: the recipe and photos behind a public link, the cover a link preview shows, and the unsubscribe link a mail carries.
Settings
The household-wide settings. Everyone reads them; only the owner changes them.
Users
Managing the accounts of an instance, which is for administrators, and reading any account's picture.
Tokens
Managing the API tokens a program authenticates with.
MCP
The Model Context Protocol endpoint an AI agent connects to. API tokens only.