Start importing a recipe from a web page

recipes.recipe.import_url

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

Command
Rigel runs it
Applies offline

Makes a recipe in the importing state, titled after the site, and a job reads the page and fills in the real recipe. Wait for import_state to leave importing, then read the recipe with recipes.recipe.get. Only http and https addresses work.

Parameters#

Start importing a recipe from a web page: 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.

Start importing a recipe from a web page: request body fields
Field	Description
`url`string (uri)required	A web address starting with http:// or https://, at most 2,000 characters. at most 2,000 characters

Response#

200 The command was applied.

Start importing a recipe from a web page: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`result.recipe_id`stringrequired	The new recipe, still importing.
`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.

Start importing a recipe from a web page: 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`	`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.

A page with www in its address

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.import_url' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "url": "https://www.seriouseats.com/recipes/chicken-tikka-masala"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.import_url", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    url: "https://www.seriouseats.com/recipes/chicken-tikka-masala",
  }),
});
const data = await response.json();

Request, HTTP

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

{
  "url": "https://www.seriouseats.com/recipes/chicken-tikka-masala"
}

Response, 200

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

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

An address without www

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/recipes.recipe.import_url' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "url": "http://smittenkitchen.com/x"
}'

Request, TypeScript

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

Request, HTTP

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

{
  "url": "http://smittenkitchen.com/x"
}

Response, 200

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

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

For Rigel#

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