Add one ingredient

recipes.ingredient.add

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

Command
Rigel runs it
Applies offline

Adds one ingredient line, last or before another ingredient of the same recipe. For hand edits; use recipes.recipe.set_ingredients for bigger changes.

Parameters#

Add 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.

Add one ingredient: request body fields
Field	Description
`recipe_id`stringrequired	A recipe ID, such as rcp_01JC0000000000000000000000.
`before_ingredient_id`string or nulloptional	The ingredient to place this before, or null for last.
`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`stringrequired	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.

Add one ingredient: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`result.ingredient_id`stringrequired	The new ingredient.
`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.

Add 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`	Before an ingredient of another recipe.
`404`	`recipe_not_found`	A recipe that isn't there.
`404`	`product_not_found`	A product that isn't on the list.
`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.

Goes before another ingredient and shifts the rest

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "before_ingredient_id": "rci_01JC000000000000000000000Y",
  "name": "sugar",
  "quantity": 1,
  "unit": "tbsp"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add", {
  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",
    before_ingredient_id: "rci_01JC000000000000000000000Y",
    name: "sugar",
    quantity: 1,
    unit: "tbsp",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "before_ingredient_id": "rci_01JC000000000000000000000Y",
  "name": "sugar",
  "quantity": 1,
  "unit": "tbsp"
}

Response, 200

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

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

Goes last when no ingredient is named

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "name": "milk",
  "quantity": 1,
  "unit": "cup"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add", {
  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",
    name: "milk",
    quantity: 1,
    unit: "cup",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "name": "milk",
  "quantity": 1,
  "unit": "cup"
}

Response, 200

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

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

Goes last when before is null

Request, curl

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

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add", {
  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",
    before_ingredient_id: null,
    name: "milk",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "before_ingredient_id": null,
  "name": "milk"
}

Response, 200

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

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

The first ingredient of an empty recipe

Request, curl

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

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add", {
  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",
    name: "salt",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "name": "salt"
}

Response, 200

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

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

Linked to a product from the shared list

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "name": "all-purpose flour",
  "quantity": 2,
  "unit": "cup",
  "product_id": "prd_01JC000000000000000000000P"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add", {
  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",
    name: "all-purpose flour",
    quantity: 2,
    unit: "cup",
    product_id: "prd_01JC000000000000000000000P",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "name": "all-purpose flour",
  "quantity": 2,
  "unit": "cup",
  "product_id": "prd_01JC000000000000000000000P"
}

Response, 200

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

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

Before an ingredient of another recipe

Request, curl

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

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add", {
  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",
    before_ingredient_id: "rci_01JC000000000000000000000Z",
    name: "x",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "before_ingredient_id": "rci_01JC000000000000000000000Z",
  "name": "x"
}

Response, 404

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

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

A recipe that isn't there

Request, curl

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

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add", {
  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",
    name: "x",
  }),
});
const data = await response.json();

Request, HTTP

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

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

Response, 404

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

{
  "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_01K9D9S2R03VW62RMN4YYDBQBW"
  }
}

A product that isn't on the list

Request, curl

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

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.ingredient.add", {
  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",
    name: "flour",
    product_id: "prd_01JC000000000000000000000P",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "name": "flour",
  "product_id": "prd_01JC000000000000000000000P"
}

Response, 404

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

{
  "error": {
    "code": "product_not_found",
    "message": "That product isn't there any more. No changes were applied.",
    "details": {
      "product_id": "prd_01JC000000000000000000000P"
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R0SM4P30SA53M9EARN"
  }
}

Add an ingredient

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.ingredient.add' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01M6V9CSE64J9NR4C0ZPF6HVMP' \
  -d '{
  "recipe_id": "rcp_01M6V9CSD8VZYF11AC568Y7QPZ",
  "name": "red pepper flakes",
  "quantity": 1,
  "unit": "pinch",
  "is_optional": true
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.ingredient.add", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01M6V9CSE64J9NR4C0ZPF6HVMP",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    recipe_id: "rcp_01M6V9CSD8VZYF11AC568Y7QPZ",
    name: "red pepper flakes",
    quantity: 1,
    unit: "pinch",
    is_optional: true,
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01M6V9CSD8VZYF11AC568Y7QPZ",
  "name": "red pepper flakes",
  "quantity": 1,
  "unit": "pinch",
  "is_optional": true
}

Response, 200

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

{
  "result": {
    "ingredient_id": "rci_01M6V9CSE6VCPVFF35JFAZE7DV"
  },
  "version": 57
}

For Rigel#

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