Recipes

List recipes

Every recipe in the accounts your token can reach, most recently changed first.

• A listing never carries steps or images — ask for one recipe to get those.
• Search runs one term at a time. To require two ingredients, filter the second yourself.

Get a recipe

One recipe in full, with its prep, method, cover and photographs.

Create a recipe

Add a recipe to the account. It is private until you publish it.

{
    "name": "Kimchi pancakes",
    "description": "Crisp at the edges.",
    "ingredients": [
        {
            "name": "200g kimchi"
        },
        {
            "name": "150g plain flour"
        },
        {
            "name": "1 egg"
        }
    ],
    "prepSteps": [
        {
            "content": "Chop the kimchi roughly."
        }
    ],
    "steps": [
        {
            "content": "Mix everything to a loose batter."
        },
        {
            "content": "Fry until crisp."
        }
    ],
    "tags": [
        "korean",
        "quick"
    ],
    "metadata": {
        "servings": "2",
        "cookTime": "15 minutes"
    }
}

• `prepSteps` and `steps` are separate sections and are written independently. Sending one never disturbs the other.

Update a recipe

Change one. Anything you leave out is left alone; a list you send replaces that list entirely.

{
    "name": "Kimchi pancakes, properly",
    "tags": [
        "korean"
    ]
}

• PUT is accepted and does exactly the same thing. Despite the verb it is still a partial update — it does not blank the fields you leave out.

Delete a recipe

Moves it to the bin. Recoverable for 30 days, then removed for good along with its photographs.

• A recipe reached through a collection somebody shared with you can be read and edited, never deleted. That comes back 403.
• It disappears from every collection and every book that held it, and from every listing — unless you ask for changes `since` a timestamp, which includes it so a synced device knows to drop it.
• Its steps and photographs go with it and come back with it. The files stay on disk until the retention window closes.

Restore a recipe

Takes one back out of the bin, with the steps and photographs it went down with.

• Only what was deleted with the recipe comes back. A photograph you removed on purpose a week earlier stays removed.
• Past the retention window there is nothing left to restore and this answers 404, the same as an id that never existed.
• It rejoins the collections and books it was in — membership survives the deletion, so a restore puts it back where it was rather than leaving you to file it again.

Read a recipe

The recipe already turned into pages: ingredients chunked, amounts linked into the method, timers parsed. Render these and hold no recipe logic of your own.

• This is the same computation the website's own reader uses, so what you render matches what a cook sees on recipejam.com. Reimplementing the chunking or the ingredient linking on a client will drift from it, and the drift shows up as a wrong amount in somebody's kitchen.
• A recipe with no ingredients, equipment or steps returns no pages at all — an empty `pages` array rather than a cover with nothing behind it.
• Photograph URLs need your token, like every other image in this API.
• Cache against `subject.updatedAt`. If it has not moved, neither have the pages.