Replace a recipe's whole step list

recipes.recipe.set_steps

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

Command
Rigel runs it
Applies offline

For big edits. Steps passed with an id keep that step; steps without an id are new; steps not in the list are deleted. Each step's ingredient_ids become its links exactly, and each must be an ingredient of this recipe (ingredient_not_found otherwise), so set the ingredients first. An id from another recipe is step_not_found.

Parameters#

Replace a recipe's whole step list: 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.

Replace a recipe's whole step list: request body fields
Field	Description
`recipe_id`stringrequired	A recipe ID, such as rcp_01JC0000000000000000000000.
`steps`array of objectsrequired	The new step list in order, at most 200. at most 200 items
`steps[].id`stringoptional	A step already in this recipe, to keep it.
`steps[].section`string or nulloptional	A group heading such as "For the paneer" or "Sauce", 1–80 characters. 1 to 80 characters
`steps[].text`stringrequired	The instruction, as written, 1–2,000 characters. 1 to 2,000 characters
`steps[].timer_seconds`integer or nulloptional	A timer this step offers in cooking mode, in seconds, 1–86,400. Simmer 12 minutes is 720. 1 to 86,400
`steps[].note`string or nulloptional	A kitchen note on this step, at most 1,000 characters. at most 1,000 characters
`steps[].ingredient_ids`array of stringsoptional	The recipe's ingredients this step uses. The step's links become exactly these. at most 200 items

Response#

200 The command was applied.

Replace a recipe's whole step list: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`result.step_ids`array of stringsrequired	Every step, in order.
`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.

Replace a recipe's whole step list: 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`	A link to an ingredient of another recipe.
`404`	`step_not_found`	A step from another recipe.
`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.

Keeps a step and relinks it, drops one, adds one with a link

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": [
    {
      "id": "rcs_01JC0000000000000000000001",
      "text": "Mix",
      "ingredient_ids": [
        "rci_01JC000000000000000000000Y"
      ]
    },
    {
      "text": "Serve",
      "ingredient_ids": [
        "rci_01JC000000000000000000000X"
      ]
    }
  ]
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps", {
  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",
    steps: [
      {
        id: "rcs_01JC0000000000000000000001",
        text: "Mix",
        ingredient_ids: [
          "rci_01JC000000000000000000000Y",
        ],
      },
      {
        text: "Serve",
        ingredient_ids: [
          "rci_01JC000000000000000000000X",
        ],
      },
    ],
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": [
    {
      "id": "rcs_01JC0000000000000000000001",
      "text": "Mix",
      "ingredient_ids": [
        "rci_01JC000000000000000000000Y"
      ]
    },
    {
      "text": "Serve",
      "ingredient_ids": [
        "rci_01JC000000000000000000000X"
      ]
    }
  ]
}

Response, 200

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

{
  "result": {
    "step_ids": [
      "rcs_01JC0000000000000000000001",
      "rcs_01JC4N0000MBGE5RJ6Q7V6V6T8"
    ]
  },
  "version": 1
}

Reordering renumbers positions

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": [
    {
      "id": "rcs_01JC0000000000000000000002",
      "text": "Bake"
    },
    {
      "id": "rcs_01JC0000000000000000000001",
      "text": "Mix",
      "ingredient_ids": [
        "rci_01JC000000000000000000000X",
        "rci_01JC000000000000000000000Y"
      ]
    }
  ]
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps", {
  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",
    steps: [
      {
        id: "rcs_01JC0000000000000000000002",
        text: "Bake",
      },
      {
        id: "rcs_01JC0000000000000000000001",
        text: "Mix",
        ingredient_ids: [
          "rci_01JC000000000000000000000X",
          "rci_01JC000000000000000000000Y",
        ],
      },
    ],
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": [
    {
      "id": "rcs_01JC0000000000000000000002",
      "text": "Bake"
    },
    {
      "id": "rcs_01JC0000000000000000000001",
      "text": "Mix",
      "ingredient_ids": [
        "rci_01JC000000000000000000000X",
        "rci_01JC000000000000000000000Y"
      ]
    }
  ]
}

Response, 200

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

{
  "result": {
    "step_ids": [
      "rcs_01JC0000000000000000000002",
      "rcs_01JC0000000000000000000001"
    ]
  },
  "version": 1
}

A link to an ingredient of another recipe

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": [
    {
      "text": "Mix",
      "ingredient_ids": [
        "rci_01JC000000000000000000000Z"
      ]
    }
  ]
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps", {
  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",
    steps: [
      {
        text: "Mix",
        ingredient_ids: [
          "rci_01JC000000000000000000000Z",
        ],
      },
    ],
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": [
    {
      "text": "Mix",
      "ingredient_ids": [
        "rci_01JC000000000000000000000Z"
      ]
    }
  ]
}

Response, 404

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

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

A step from another recipe

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": [
    {
      "id": "rcs_01JC0000000000000000000003",
      "text": "Heat"
    }
  ]
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps", {
  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",
    steps: [
      {
        id: "rcs_01JC0000000000000000000003",
        text: "Heat",
      },
    ],
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": [
    {
      "id": "rcs_01JC0000000000000000000003",
      "text": "Heat"
    }
  ]
}

Response, 404

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

{
  "error": {
    "code": "step_not_found",
    "message": "That step isn't in this recipe. No changes were applied.",
    "details": {
      "step_id": "rcs_01JC0000000000000000000003"
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R03ZYKY47NSJ80NY81"
  }
}

A recipe that isn't there

Request, curl

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

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.set_steps", {
  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",
    steps: [],
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "steps": []
}

Response, 404

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

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

For Rigel#

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