Move one ingredient

recipes.ingredient.move

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

Command
Rigel runs it
Applies offline

Puts the ingredient just before another ingredient of the same recipe, or last when before_ingredient_id is null.

Parameters#

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

Move one ingredient: request body fields
Field	Description
`ingredient_id`stringrequired	A recipe ingredient ID, such as rci_01JC0000000000000000000000.
`before_ingredient_id`string or nullrequired	The ingredient to place this before, or null for last.

Response#

200 The command was applied.

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

Move 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. An ingredient 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.

The first ingredient to last

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "before_ingredient_id": null
}

Response, 200

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

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

The last ingredient to first

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000Y",
  "before_ingredient_id": "rci_01JC000000000000000000000X"
}

Response, 200

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

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

Before itself changes nothing

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "before_ingredient_id": "rci_01JC000000000000000000000X"
}

Response, 200

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

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

Before an ingredient of another recipe

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "before_ingredient_id": "rci_01JC000000000000000000000Z"
}

Response, 404

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

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

An ingredient that isn't there

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "ingredient_id": "rci_01JC000000000000000000000X",
  "before_ingredient_id": null
}

Response, 404

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

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

Move an ingredient up

Put it before another ingredient, or send null to put it last.

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.ingredient.move' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01M6V9CSEAP1ZCDTTZ2EWNX1WG' \
  -d '{
  "ingredient_id": "rci_01M6V9CSE6VCPVFF35JFAZE7DV",
  "before_ingredient_id": "rci_01M6V9CSD8Y6T0ADACG3WMTNWC"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.ingredient.move", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01M6V9CSEAP1ZCDTTZ2EWNX1WG",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    ingredient_id: "rci_01M6V9CSE6VCPVFF35JFAZE7DV",
    before_ingredient_id: "rci_01M6V9CSD8Y6T0ADACG3WMTNWC",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "ingredient_id": "rci_01M6V9CSE6VCPVFF35JFAZE7DV",
  "before_ingredient_id": "rci_01M6V9CSD8Y6T0ADACG3WMTNWC"
}

Response, 200

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

{
  "result": {},
  "version": 59
}

For Rigel#

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