Change a recipe's title, summary, servings, times, notes or source

recipes.recipe.update

POST/api/v1/households/{household_id}/commands/recipes.recipe.update

Command
Rigel runs it
Applies offline

Sets only the fields given; send null to clear one that can be empty. Changing servings doesn't rescale the amounts; use recipes.recipe.scale for that.

Parameters#

Change a recipe's title, summary, servings, times, notes or source: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.
`Idempotency-Key`headerstringoptional	The command's ID. Reuse it when retrying the same command.

Request body#

JSON, as application/json.

Change a recipe's title, summary, servings, times, notes or source: request body fields
Field	Description
`recipe_id`stringrequired	A recipe ID, such as rcp_01JC0000000000000000000000.
`title`stringoptional	The recipe's title, as written, 1–200 characters. 1 to 200 characters
`servings`integeroptional	How many servings the amounts make, a whole number from 1 to 100. 1 to 100
`summary`string or nulloptional	One or two sentences about the recipe, at most 500 characters. at most 500 characters
`prep_minutes`integer or nulloptional	A time in whole minutes, 0–2,880 (two days). 0 to 2,880
`cook_minutes`integer or nulloptional	A time in whole minutes, 0–2,880 (two days). 0 to 2,880
`notes`string or nulloptional	Kitchen notes on the whole recipe, as written, at most 5,000 characters: "Freezes well for 3 months." at most 5,000 characters
`source_title`string or nulloptional	Where the recipe came from, as published, at most 200 characters: a title, a site or book, or an author. at most 200 characters
`source_site`string or nulloptional	Where the recipe came from, as published, at most 200 characters: a title, a site or book, or an author. at most 200 characters
`source_author`string or nulloptional	Where the recipe came from, as published, at most 200 characters: a title, a site or book, or an author. at most 200 characters
`source_url`string (uri) or nulloptional	A web address starting with http:// or https://, at most 2,000 characters. at most 2,000 characters

Response#

200 The command was applied.

Change a recipe's title, summary, servings, times, notes or source: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`version`integerrequired	The household version after the command.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Change a recipe's title, summary, servings, times, notes or source: errors
Status	Code	When
`400`	`validation_failed`	A field is missing, misspelled or out of range. details.fields lists each problem.
`401`	`unauthenticated`	The request has no valid session.
`404`	`recipe_not_found`	A recipe that isn't there.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.
`409`	`idempotency_key_reused`	The Idempotency-Key was already used for a different command.

Examples#

These are real. Each scenario is one of the command's test cases, run on a household when this site was built, and the response is what the API returned.

Changes some fields and clears one

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "title": "Fluffy pancakes",
  "servings": 6,
  "summary": null,
  "prep_minutes": 5
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    recipe_id: "rcp_01JC000000000000000000000A",
    title: "Fluffy pancakes",
    servings: 6,
    summary: null,
    prep_minutes: 5,
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "title": "Fluffy pancakes",
  "servings": 6,
  "summary": null,
  "prep_minutes": 5
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0TGQR2R2EVY1RE4TZ

{
  "result": {},
  "version": 1
}

Sets source fields

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "source_url": "https://example.com/p",
  "source_title": "Pancakes",
  "source_site": "Example",
  "source_author": "Sam"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    recipe_id: "rcp_01JC000000000000000000000A",
    source_url: "https://example.com/p",
    source_title: "Pancakes",
    source_site: "Example",
    source_author: "Sam",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "source_url": "https://example.com/p",
  "source_title": "Pancakes",
  "source_site": "Example",
  "source_author": "Sam"
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0VRSTBJATC79XBMWY

{
  "result": {},
  "version": 1
}

No fields only marks it changed

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    recipe_id: "rcp_01JC000000000000000000000A",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "recipe_id": "rcp_01JC000000000000000000000A"
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R076N3R82JAWGDZ3HX

{
  "result": {},
  "version": 1
}

A recipe that isn't there

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "title": "x"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    recipe_id: "rcp_01JC000000000000000000000A",
    title: "x",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "title": "x"
}

Response, 404

HTTP/1.1 404 Not Found
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0GHZE4PP8X5KRZW6Q

{
  "error": {
    "code": "recipe_not_found",
    "message": "That recipe isn't in the recipe box any more. No changes were applied.",
    "details": {
      "recipe_id": "rcp_01JC000000000000000000000A"
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R0GHZE4PP8X5KRZW6Q"
  }
}

Change a recipe's details

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.recipe.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01M6V9CSE26N0BKNVHHAWSKVGP' \
  -d '{
  "recipe_id": "rcp_01M6V9CSD8VZYF11AC568Y7QPZ",
  "notes": "Nia likes it with extra spinach. Leave the pepper flakes out for Theo; he isn'\''t into spicy food lately."
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.recipe.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01M6V9CSE26N0BKNVHHAWSKVGP",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    recipe_id: "rcp_01M6V9CSD8VZYF11AC568Y7QPZ",
    notes: "Nia likes it with extra spinach. Leave the pepper flakes out for Theo; he isn't into spicy food lately.",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.recipe.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01M6V9CSE26N0BKNVHHAWSKVGP

{
  "recipe_id": "rcp_01M6V9CSD8VZYF11AC568Y7QPZ",
  "notes": "Nia likes it with extra spinach. Leave the pepper flakes out for Theo; he isn't into spicy food lately."
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CSE281E1V29XR04B05HX

{
  "result": {},
  "version": 55
}

For Rigel#

Rigel's tool for this command is recipes_recipe_update. Rigel runs this on its own, then says what it did. The agent guide has the rest.