The API and the recipe format.

Build on Savorum with its HTTP API, or work with recipes directly through the open SREF format.

Work with the recipe.

SREF describes portable recipe content, independently of Savorum’s storage and interface. Explore exact quantities, explicit units, source wording, and the files inside a complete recipe package.

SREF0.4.0Format version
Explore the format

Download a real recipe package and inspect it with an ordinary ZIP tool.

Exports, backups, and credentials.

A recipe export carries the recipe. An instance backup carries the whole library too: books, tags, notes, ratings, cooking history, and earlier versions. Pick the one that fits your integration.

An instance with sign-in enabled authenticates browser sessions and personal API tokens. Send a token as an Authorization: Bearer header and name a library with X-Savorum-Library; scopes and the account’s library membership both apply. Cookie-authenticated writes also need the session-bound CSRF header, which bearer requests do not.

The OpenAPI document declares these credentials as the bearerToken and browserSession security schemes, so a generated client can send either, and operations that answer without credentials say so. An instance left in local mode authenticates nobody: keep it private behind an access-controlled network or proxy.

How the format is tested.

SREF’s reference implementation and conformance corpus check the exchange contract. JSON parsing alone cannot establish that a fraction is canonical, a reference resolves, a unit has the right meaning, or a package is safe to read.

The separate recipe corpus exercises difficult real-world material across the format and application: regional units, partial quantities, alternatives, authored wording, and assets. Each project has a different job, with the recipe at the center.