Make a version of a recipe

recipes.recipe.copy

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

Command
Rigel runs it
Applies offline

Copies a recipe with its fields, source, pictures, ingredients, steps and step links into a new recipe based on it, so the family can change it without touching the original. Cooks and the imported source text aren't copied; recipes.recipe.get_source on the copy reads the original's.

Parameters#

Make a version of a recipe: 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.

Make a version of a recipe: request body fields
Field	Description
`recipe_id`stringrequired	A recipe ID, such as rcp_01JC0000000000000000000000.
`title`stringrequired	The recipe's title, as written, 1–200 characters. 1 to 200 characters

Response#

200 The command was applied.

Make a version of a recipe: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`result.recipe_id`stringrequired	The new recipe.
`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.

Make a version of a recipe: 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.

Copies the fields, pictures, ingredients, steps and links with new IDs

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

{
  "recipe_id": "rcp_01JC000000000000000000000A",
  "title": "Meatless pancakes"
}

Response, 200

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

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

A recipe with nothing in it

Request, curl

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

Request, TypeScript

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

Request, HTTP

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

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

Response, 200

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

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

A recipe that isn't there

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.copy' \
  -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.copy", {
  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.copy 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_01K9D9S2R0TV2SVGED71QHRF6F

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

Make a variation of a recipe

The copy remembers what it was based on.

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.recipe.copy' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01M6V9CSEKT0KCJT5TKFYTKFWX' \
  -d '{
  "recipe_id": "rcp_01M6V9CSDDZVYFRVFNA4X5BSMZ",
  "title": "Saturday pancakes, dairy free"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/recipes.recipe.copy", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01M6V9CSEKT0KCJT5TKFYTKFWX",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    recipe_id: "rcp_01M6V9CSDDZVYFRVFNA4X5BSMZ",
    title: "Saturday pancakes, dairy free",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "recipe_id": "rcp_01M6V9CSDDZVYFRVFNA4X5BSMZ",
  "title": "Saturday pancakes, dairy free"
}

Response, 200

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

{
  "result": {
    "recipe_id": "rcp_01M6V9CSEK23234BDRJW83RQTG"
  },
  "version": 64
}

For Rigel#

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