Change one ingredient

recipes.ingredient.update

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

Command
Rigel runs it
Applies offline

Sets only the fields given; send null to clear one that can be empty. After the change, a quantity_max needs a quantity and must be more than it, or the command fails with invalid_amount.

Parameters#

Change one ingredient: 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 one ingredient: request body fields
Field	Description
`ingredient_id`stringrequired	A recipe ingredient ID, such as rci_01JC0000000000000000000000.
`section`string or nulloptional	A group heading such as "For the paneer" or "Sauce", 1–80 characters. 1 to 80 characters
`product_id`string or nulloptional	The product from the shared product list (`inventory.product.search` finds one), when the match is clear.
`name`stringoptional	The ingredient as written, 1–200 characters: "boneless chicken thighs". 1 to 200 characters
`quantity`number or nulloptional	How much, or null for 'to taste' or 'a pinch'. greater than 0, at most 1,000,000
`quantity_max`number or nulloptional	The top of a range such as 2–3 cloves; more than quantity. Null if it isn't a range. greater than 0, at most 1,000,000
`unit`one of: mg, g, kg, oz, lb, ml, l, tsp, tbsp, fl_oz, cup, pint, quart, gallon, pinch, dash, clove, slice, stick, sprig, head, bunch, stalk, can, jar, bottle, box, bag, package, carton, roll, null or nulloptional	A unit. Mass: mg, g, kg, oz, lb. Volume (US sizes): ml, l, tsp, tbsp, fl_oz, cup, pint, quart, gallon. Items, for a count of something other than the thing itself (2 cloves of garlic, 1 can of beans): pinch, dash, clove, slice, stick, sprig, head, bunch, stalk, can, jar, bottle, box, bag, package, carton, roll. Leave it out or null for a plain count of the things themselves (3 eggs).
`preparation`string or nulloptional	How the ingredient is prepared, at most 200 characters: "diced", "at room temperature". at most 200 characters
`is_optional`booleanoptional	Whether the ingredient can be left out. Defaults to false.

Response#

200 The command was applied.

Change one ingredient: 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 one ingredient: 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`	`ingredient_not_found`	An ingredient that isn't there.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.
`409`	`invalid_amount`	The top of a range below the amount. Clearing the amount of a range.
`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 an amount and adds a preparation

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "quantity": 3,
  "preparation": "sifted"
}'

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "quantity": 3,
  "preparation": "sifted"
}

Response, 200

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

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

Makes it a range and optional, and clears the unit

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "quantity_max": 4,
  "is_optional": true,
  "unit": null
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    ingredient_id: "rci_01JC000000000000000000000X",
    quantity_max: 4,
    is_optional: true,
    unit: null,
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "quantity_max": 4,
  "is_optional": true,
  "unit": null
}

Response, 200

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

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

The top of a range below the amount

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "quantity_max": 1
}

Response, 409

HTTP/1.1 409 Conflict
Content-Type: application/json
X-Request-Id: req_01K9D9S2R03WAVMFSQNX9Q3Q36

{
  "error": {
    "code": "invalid_amount",
    "message": "The top of a range needs an amount and has to be more than it. No changes were applied.",
    "details": {
      "quantity": 2,
      "quantity_max": 1
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R03WAVMFSQNX9Q3Q36"
  }
}

Clearing the amount of a range

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000Y",
  "quantity": null
}

Response, 409

HTTP/1.1 409 Conflict
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0WBG5H3CVGHYYACGY

{
  "error": {
    "code": "invalid_amount",
    "message": "The top of a range needs an amount and has to be more than it. No changes were applied.",
    "details": {
      "quantity": null,
      "quantity_max": 3
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R0WBG5H3CVGHYYACGY"
  }
}

An ingredient that isn't there

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "name": "x"
}

Response, 404

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

{
  "error": {
    "code": "ingredient_not_found",
    "message": "That ingredient isn't in the recipe any more. No changes were applied.",
    "details": {
      "ingredient_id": "rci_01JC000000000000000000000X"
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R0C9BB5BR87FZT444S"
  }
}

Change an ingredient

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.ingredient.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01M6V9CSE97FCMP7BWJJ76Q4PS' \
  -d '{
  "ingredient_id": "rci_01M6V9CSD8DPC2ZFAC3657BTP5",
  "quantity": 3,
  "unit": "cup"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.ingredient.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01M6V9CSE97FCMP7BWJJ76Q4PS",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    ingredient_id: "rci_01M6V9CSD8DPC2ZFAC3657BTP5",
    quantity: 3,
    unit: "cup",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "ingredient_id": "rci_01M6V9CSD8DPC2ZFAC3657BTP5",
  "quantity": 3,
  "unit": "cup"
}

Response, 200

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

{
  "result": {},
  "version": 58
}

For Rigel#

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