Meal planning settings and which week is current

meals.setting.get

GET/api/v1/households/{household_id}/queries/meals.setting.get

Query
Rigel runs it

The effective settings (the defaults until someone changes them), plus current_week_start, the first day of the plan week containing today in the household's time zone, and next_week_start, the week after it. Use these dates for "this week" and "next week".

Parameters#

Meal planning settings and which week is current: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.

Response#

200 The answer.

Meal planning settings and which week is current: response fields
Field	Description
`planning_weekday`integerrequired	The day Rigel plans the coming week, 1 = Monday … 7 = Sunday. 1 to 7
`planning_time`stringrequired	A local time of day in the household's time zone, "HH:MM" on a 24-hour clock, such as "09:00". pattern ^([01]\d\|2[0-3]):[0-5]\d$
`week_starts_on`integerrequired	The first day of a plan week, 1 = Monday … 7 = Sunday. 1 to 7
`is_auto_planning_on`booleanrequired	Whether Rigel fills the week on the planning day.
`current_week_start`string (date)required	The first day of the plan week that contains today.
`next_week_start`string (date)required	The first day of the plan week after the current one.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Meal planning settings and which week is current: 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.

Examples#

These are real. Each was recorded from a sample household, the Okafors, running through the whole API when this site was built.

When does Rigel plan the week?

Request, curl

curl 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/meals.setting.get' \
  -H "Cookie: rigel_session=$RIGEL_SESSION"

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/meals.setting.get", {
  headers: {
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
});
const data = await response.json();

Request, HTTP

GET /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/meals.setting.get HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>

Response, 200

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

{
  "planning_weekday": 3,
  "planning_time": "09:00",
  "week_starts_on": 1,
  "is_auto_planning_on": true,
  "current_week_start": "2026-11-02",
  "next_week_start": "2026-11-09"
}

For Rigel#

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