Plans

The week: plan it, read it, swap a dinner, lock a day.19 operations

Headers on every response

Every response on this page carries these headers.

X-Trace-Id: — The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing: — Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics: — Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).

Operations

POST/api/v1/households/{householdId}/plans/generate

Put the week in the planning queue and answer with the run

Adults only; a Junior member gets 403. Answers 202 with the run's id (ADR-289): the week is built by a background job, GET plans/runs/{jobId} says where the run stands, and the phone is told by push when the week lands (#200). Costs credits unless the cookbook or the starter library answers every day — GET cost-estimate says the price first. A second press while the run is going joins it and gets the same run id back; 409 with code week_planning_in_progress only for two presses in the very same instant (ADR-073). What the run itself can end in — rules that cannot all be met, a provider that never answered — is on the run's status, not here.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—

Request body

application/jsonRequiredGeneratePlanRequest

Responses

202Accepted

application/jsonPlanRunAccepted

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

409Conflict

application/problem+jsonProblemDetails

426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/generate" \
  -H "Content-Type: application/json" \
  -d '{"weekStart":"2026-09-07"}'

Example response

202application/json

{
  "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStart": "2026-09-07"
}

GET/api/v1/households/{householdId}/plans/runs/{jobId}

Say where a planning run stands, and why it ended if it ended badly

Any member — the week is the household's and so is the wait. status is queued, running, done or failed; queuePosition counts from one while the run waits, and counts the runs already in the model, because they are what it is waiting for. planId is the week the run settled, once it is done. failure carries the problem the run would have answered with while a request was still open — planning_conflict with its errors, for one (ADR-289).

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`jobId`	path	`string (uuid)`	Required	—

Responses

200OK

application/jsonPlanRunStatusResponse

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/runs/3fa85f64-5717-4562-b3fc-2c963f66afa6"

Example response

200application/json

{
  "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStart": "2026-09-07",
  "status": "Queued",
  "queuePosition": 0,
  "planId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "startedAt": "2026-09-07T16:30:00Z"
}

GET/api/v1/households/{householdId}/plans/cost-estimate

Estimate what planning the week would cost, with a day-by-day preflight

Reads only — nothing is generated or charged (#340). Answers the credits, what is left of the quota, whether the run would be admitted, and a preflight of what each day becomes if the run is pressed as it stands (#694, ADR-066). scope defaults to WholeWeek; allowGeneration overrides the household's cap on new dishes for this estimate only. lockedDates and excludedTitles are the sheet's «Låst» and «Ikke denne» (ADR-356 (#3244)), read exactly as the run's policy reads them; lockedDates absent means the plan's own locks. heldDishes («yyyy-MM-dd:Title») are the cookbook dishes the sheet already showed on days nobody touched, held there so re-pricing does not move them (ADR-366 (#3288)).

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`weekStart`	query	`string (date)`	Required	—
`scope`	query	`ReplanScope`	—	—
`allowGeneration`	query	`integer (int32)`	—	—
`lockedDates`	query	`string (date)[]`	—	—
`excludedTitles`	query	`string[]`	—	—
`heldDishes`	query	`string[]`	—	—

Responses

200OK

application/jsonPlanCostEstimateResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/cost-estimate?weekStart=2026-09-07"

Example response

200application/json

{
  "credits": 0,
  "remaining": 0,
  "affordable": false,
  "daysToGenerate": 0,
  "usesStarterLibrary": false,
  "resetsAt": "2026-09-07T16:30:00Z",
  "suggestMoreCredits": 0,
  "affordableNewDishes": 0,
  "shortfall": 0
}

GET/api/v1/households/{householdId}/plans/overview

List which days carry a dinner, week by week, for a window of at most 92 days

Month-map data: each week's status, each day's entry type and dish name, and whether the week has a shopping list and when the trip was finished. from and to are both required and from must not be after to (#445), and the window may cover at most 92 days — a calendar read, not a page (#2977, ADR-292). The widest any client asks for is a month grid's six weeks.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`from`	query	`string (date)`	Required	—
`to`	query	`string (date)`	Required	—

Responses

200OK

application/jsonPlanOverviewResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/overview?from=2026-09-07&to=2026-09-07"

Example response

200application/json

{
  "weeks": [
    {
      "weekStart": "2026-09-07",
      "status": {},
      "days": [
        {}
      ],
      "hasShoppingList": false,
      "changedSinceShopped": 0
    }
  ]
}

GET/api/v1/households/{householdId}/plans/by-week/{weekStart}

Get the week's live plan

weekStart is the week's Monday. Superseded versions are never returned; 404 when the week has no plan.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`weekStart`	path	`string (date)`	Required	—

Responses

200OK

application/jsonWeeklyPlanResponse

400The request could not be read as the route needs it: a body that is not the documented shape (a required field left out, a null where none is allowed, a value too long for its field), a parameter that does not parse, or a NUL character anywhere (#3540, #3541, #3543). Code validation_failed or value_too_long.

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/by-week/2026-09-07"

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

GET/api/v1/households/{householdId}/plans/by-week/{weekStart}/use-up

Read the use-up bundle for a week: what is running out after the planned use, and the fewest swaps that would use it.

weekStart is normalised to its Monday. Anchored at that Monday or today, whichever is later, while every deadline is measured from today (ADR-175): a week whose days are all past the food's life gets an empty bundle, and so does a week that is over. The bundle carries an id; apply or dismiss it through the home use-up endpoints. Read-only. A weekStart far outside the calendar a household lives in answers 400.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`weekStart`	path	`string (date)`	Required	—

Responses

200OK

application/jsonHomeUseUpBundleQuestion

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/by-week/2026-09-07/use-up"

Example response

200application/json

{
  "bundleId": "string",
  "changes": [
    {
      "id": "string",
      "day": "2026-09-07",
      "kind": {},
      "recipeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "uses": [
        {}
      ],
      "handsBack": [
        {}
      ],
      "activeMinutes": 0,
      "shoppingDelta": 0
    }
  ],
  "coveredCount": 0,
  "urgentCount": 0,
  "notDinner": [
    {
      "foodKey": "string",
      "displayName": "string",
      "reason": {}
    }
  ]
}

POST/api/v1/households/{householdId}/plans/{planId}/activate

Make this plan the week's live plan

Adults only; a Junior member gets 403. Any other live plan for the same week is superseded first (#437). Safe to retry: activating the plan that is already active changes nothing and answers 200.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—

Responses

200OK

application/jsonWeeklyPlanResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/activate"

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

POST/api/v1/households/{householdId}/plans/{planId}/restore

Undo a replan: bring back the plan this one replaced

Adults only; a Junior member gets 403. The given plan is superseded and the week's previous plan is live again; the shopping list follows it back, but the credits the run spent are not refunded (#342). 409 with code plan_not_current when the week has been planned again since and this plan is no longer the week's — resync the page. 422 with code no_earlier_plan when this is the week's first plan.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—

Responses

200OK

application/jsonWeeklyPlanResponse

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

409Conflict

application/problem+jsonProblemDetails

422Unprocessable Entity

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Problem codes

The `code` in the problem body is what to branch on. `detail` is English, written for a log.

no_earlier_plan: — There is no earlier version of this week to go back to.
plan_not_current: — The week has been planned again since. Reload and try again.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/restore"

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

PATCH/api/v1/households/{householdId}/plans/{planId}/entries/{entryId}

Replace one day's dinner with another candidate, or make it a leftovers day

Adults only; a Junior member gets 403. Send exactly one of mealCandidateId (a candidate generated for the same date) or entryType "Leftovers" (#1691, ADR-136). Regenerates the week's shopping list if one exists. A superseded plan answers 400 — refresh to the current week.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`entryId`	path	`string (uuid)`	Required	—

Request body

application/jsonRequiredReplacePlanEntryRequest

Responses

200OK

application/jsonWeeklyPlanResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X PATCH \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Content-Type: application/json" \
  -d '{}'

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

POST/api/v1/households/{householdId}/plans/{planId}/entries/{entryId}/feedback

Say what was wrong with a planned dinner and let Bryti act on it

Adults only; a Junior member gets 403. «Si fra om denne retten» (#740, ADR-075): depending on the reason Bryti swaps the day, replans the open days, offers a variant, excludes the dish, or only notes it when the day has passed or its outcome is recorded. Two of the reasons can end in a generation, so the call may cost credits and runs under the planner's time budget (502/504 as for planning the week). The answer carries the week and a typed result the client uses for «Angre».

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`entryId`	path	`string (uuid)`	Required	—

Request body

application/jsonRequiredPlanEntryFeedbackRequest

Responses

200OK

application/jsonPlanEntryFeedbackResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

422Unprocessable Entity

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

502Bad Gateway

application/problem+jsonProblemDetails

504Gateway Timeout

application/problem+jsonProblemDetails

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback" \
  -H "Content-Type: application/json" \
  -d '{"reason":"RuleBroken"}'

Example response

200application/json

{
  "plan": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "weekStartDate": "2026-09-07",
    "status": {},
    "plannerVersion": "string",
    "scoreBreakdown": {
      "key": 0
    },
    "entries": [
      {}
    ],
    "createdAt": "2026-09-07T16:30:00Z",
    "activatedAt": "2026-09-07T16:30:00Z",
    "fromStarterLibrary": false,
    "shoppingListStale": false
  },
  "result": {
    "reason": {},
    "action": {}
  }
}

POST/api/v1/households/{householdId}/plans/{planId}/entries/{entryId}/move

Move a dinner to another day in the same week, trading places if that day has one

Adults only; a Junior member gets 403. toDate must be a day of the same plan, and the day being moved must have a dinner (#111). Regenerates the week's shopping list if one exists.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`entryId`	path	`string (uuid)`	Required	—

Request body

application/jsonRequiredMovePlanEntryRequest

Responses

200OK

application/jsonWeeklyPlanResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries/3fa85f64-5717-4562-b3fc-2c963f66afa6/move" \
  -H "Content-Type: application/json" \
  -d '{"toDate":"2026-09-07"}'

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

DELETE/api/v1/households/{householdId}/plans/{planId}

Delete the week's plan, putting the week back to «not planned»

Adults only; a Junior member gets 403. Deleting a live plan also removes the versions it superseded and the week's shopping list; deleting a superseded plan by id removes only that one (#882). The week's candidate pool survives.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—

Responses

204No Content

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X DELETE \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6"

DELETE/api/v1/households/{householdId}/plans/{planId}/entries/{entryId}/dinner

Take the dinner off a day and leave the day open

Adults only; a Junior member gets 403. Not eating out and not a swap — the day simply has nothing planned (#111). Regenerates the week's shopping list if one exists.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`entryId`	path	`string (uuid)`	Required	—

Responses

200OK

application/jsonWeeklyPlanResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X DELETE \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries/3fa85f64-5717-4562-b3fc-2c963f66afa6/dinner"

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

POST/api/v1/households/{householdId}/plans/plan-recipe

Put a recipe from the library on a day

Adults only; a Junior member gets 403. No model is asked and nothing is charged: the recipe becomes the day's dinner, scaled to that day's table (#115). A week with no plan yet is opened by the first dish (#1681). A base recipe is a part, not a dinner, and is refused with 400 (ADR-154).

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—

Request body

application/jsonRequiredPlanRecipeOnDayRequest

Responses

200OK

application/jsonWeeklyPlanResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/plan-recipe" \
  -H "Content-Type: application/json" \
  -d '{"recipeId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","date":"2026-09-07"}'

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

POST/api/v1/households/{householdId}/plans/{planId}/entries/{entryId}/lock

Lock a day's dinner so a replan leaves it alone

Adults only; a Junior member gets 403.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`entryId`	path	`string (uuid)`	Required	—

Responses

200OK

application/jsonWeeklyPlanResponse

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries/3fa85f64-5717-4562-b3fc-2c963f66afa6/lock"

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

POST/api/v1/households/{householdId}/plans/{planId}/entries/{entryId}/unlock

Unlock a day's dinner so a replan may change it again

Adults only; a Junior member gets 403.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`entryId`	path	`string (uuid)`	Required	—

Responses

200OK

application/jsonWeeklyPlanResponse

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries/3fa85f64-5717-4562-b3fc-2c963f66afa6/unlock"

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

POST/api/v1/households/{householdId}/plans/{planId}/entries/{entryId}/tips/{index}/used

Mark one of tonight's serving tips as used, or take the mark off

Any member, Juniors included — it says what happened in the kitchen and changes no plan (#696, ADR-076). index is the tip's position in the entry's stored array (ServingNoteResponse.TipIndex), not its place in the servingNotes list. Idempotent. Nothing is saved to the cookbook; the marks are what the finished screen offers to turn into a variant.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`entryId`	path	`string (uuid)`	Required	—
`index`	path	`integer (int32)`	Required	—

Request body

application/jsonRequiredSetServingTipUsedRequest

Responses

200OK

application/jsonWeeklyPlanResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries/3fa85f64-5717-4562-b3fc-2c963f66afa6/tips/0/used" \
  -H "Content-Type: application/json" \
  -d '{"used":false}'

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

POST/api/v1/households/{householdId}/plans/{planId}/entries/{entryId}/freezer

Say how many baby portions tonight's cooking put in the freezer

Any member, Juniors included — it says what happened in the kitchen (#3092). Portions is the total for this dinner, not an increment: tapping again sends two and «Angre» sends zero, so the call is idempotent. 400 when the dinner is not showing the freezer advice, or when portions is outside 0..20. Writes one pantry row on the food key baby-portion-frozen, in the freezer.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`entryId`	path	`string (uuid)`	Required	—

Request body

application/jsonRequiredSetFrozenBabyPortionsRequest

Responses

200OK

application/jsonWeeklyPlanResponse

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries/3fa85f64-5717-4562-b3fc-2c963f66afa6/freezer" \
  -H "Content-Type: application/json" \
  -d '{"portions":0}'

Example response

200application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStartDate": "2026-09-07",
  "status": "Draft",
  "plannerVersion": "string",
  "scoreBreakdown": {
    "key": 0
  },
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2026-09-07",
      "entryType": {},
      "isLocked": false,
      "portions": 0,
      "candidate": {}
    }
  ],
  "createdAt": "2026-09-07T16:30:00Z",
  "activatedAt": "2026-09-07T16:30:00Z",
  "fromStarterLibrary": false,
  "shoppingListStale": false
}

POST/api/v1/households/{householdId}/plans/{planId}/replan

Put the week back in the planning queue and answer with the run

Adults only; a Junior member gets 403. Answers 202 with the run's id (ADR-289): the week is planned again by a background job, and GET plans/runs/{jobId} says where it stands. scope defaults to OpenDays, which fills only the days with nothing on them and changes nothing already decided; WholeWeek re-solves everything that is not locked, answered for or in the past (#340). The optional body is the preflight's answer (#694, ADR-066).May cost credits — GET plans/cost-estimate says the price first. The shopping list follows the week to the new plan, and «Angre» is POST plans/{planId}/restore. A press while a run is going joins that run; 409 (week_planning_in_progress) means the same as for planning the week.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`planId`	path	`string (uuid)`	Required	—
`scope`	query	`ReplanScope`	—	—

Request body

application/jsonOptionalPlanPolicy | null

Responses

202Accepted

application/jsonPlanRunAccepted

400Bad Request

application/problem+jsonProblemDetails

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

application/problem+jsonProblemDetails

409Conflict

application/problem+jsonProblemDetails

429Too many calls in the window; Retry-After says how long.

application/problem+jsonProblemDetails

Headers

Retry-After: — Seconds to wait when a rate limit answered, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/replan" \
  -H "Content-Type: application/json" \
  -d '{"allowNearMisses":false}'

Example response

202application/json

{
  "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "weekStart": "2026-09-07"
}

Schemas

BabyPortionFit

Type

Values

NotApplicablePossibleNotPossible

CandidateContent

Property	Type	Required
`title`	`string`	Required
`rationale`	`string`	Required
`ingredients`	`CandidateIngredient[]`	Required
`steps`	`string[]`	Required
`activeMinutes`	`integer (int32)`	Required
`totalMinutes`	`integer (int32)`	Required
`portions`	`integer (int32)`	Required
`tags`	`string[]`	Required
`leftoverPotential`	`string`	Required
`confidence`	`number (double)`	Required
`assumptions`	`string[]`	Required
`safetyWarnings`	`string[]`	Required
`nutrition`	`CandidateNutrition \| null`	—
`timers`	`CandidateStepTimer[] \| null`	—
`sections`	`CandidateSection[] \| null`	—

CandidateIngredient

Property	Type	Required
`foodKey`	`string`	Required
`displayName`	`string`	Required
`quantity`	`number (double)`	Required
`unit`	`string`	Required
`isOptional`	`boolean`	Required
`missing`	`boolean`	Required
`displayQuantity`	`number (double) \| null`	—
`displayUnit`	`string \| null`	—

CandidateNutrition

Property	Type	Required
`kcalPerPortion`	`integer (int32)`	Required
`proteinGrams`	`number (double)`	Required
`fibreGrams`	`number (double)`	Required
`addedSugarGrams`	`number (double)`	Required
`saltGrams`	`number (double)`	Required
`fruitVegPortions`	`number (double)`	Required
`coverage`	`number (double)`	Required

CandidatePrice

Property	Type	Required
`class`	`PriceClass`	Required
`perPortionNok`	`number (double) \| null`	Required
`source`	`PriceSource`	Required
`coverage`	`number (double)`	Required

CandidateSection

Property	Type	Required
`name`	`string \| null`	Required
`kind`	`RecipeSectionKind`	Required
`ingredients`	`CandidateIngredient[]`	Required
`steps`	`string[]`	Required
`timers`	`CandidateStepTimer[] \| null`	Required
`sourceRecipeId`	`string (uuid) \| null`	Required
`sourceRecipeTitle`	`string \| null`	Required

CandidateStepTimer

Property	Type	Required
`step`	`integer (int32)`	Required
`minutes`	`integer (int32)`	Required
`name`	`string`	Required

DayOfWeek

Type

Values

SundayMondayTuesdayWednesdayThursdayFridaySaturday

or null

GeneratePlanRequest

Property	Type	Required
`weekStart`	`string (date)`	Required
`policy`	`PlanPolicy \| null`	—

HomeUseUpBundleQuestion

Property	Type	Required
`bundleId`	`string`	Required
`changes`	`HomeUseUpChange[]`	Required
`coveredCount`	`integer (int32)`	Required
`urgentCount`	`integer (int32)`	Required
`notDinner`	`HomeUseUpFood[]`	Required
`nextWeek`	`HomeUseUpNextWeek \| null`	—

HomeUseUpChange

Property	Type	Required
`id`	`string`	Required
`day`	`string (date)`	Required
`kind`	`HomeUseUpChangeKind`	Required
`recipeId`	`string (uuid) \| null`	Required
`title`	`string`	Required
`uses`	`HomeUseUpUse[]`	Required
`handsBack`	`HomeUseUpUse[]`	Required
`activeMinutes`	`integer (int32)`	Required
`shoppingDelta`	`integer (int32)`	Required

HomeUseUpChangeKind

Type

Values

SwapDishAdaptIngredientFillOpenDay

HomeUseUpFood

Property	Type	Required
`foodKey`	`string`	Required
`displayName`	`string`	Required
`reason`	`HomeUseUpFoodReason`	—

HomeUseUpFoodReason

Type

Values

BreadFoodNoRecipeLeftoversNoChangeInTime

Default "BreadFood"

HomeUseUpNextWeek

Property	Type	Required
`changeCount`	`integer (int32)`	Required
`foodNames`	`string[]`	Required

HomeUseUpUse

Property	Type	Required
`foodKey`	`string`	Required
`displayName`	`string`	Required
`quantity`	`number (double) \| null`	Required
`unit`	`string \| null`	Required
`usesMostOfIt`	`boolean`	—

MealCandidateResponse

Property	Type	Required
`id`	`string (uuid)`	Required
`householdId`	`string (uuid)`	Required
`targetDate`	`string (date)`	Required
`category`	`MealCategory`	Required
`content`	`CandidateContent`	Required
`scores`	`map`	Required
`createdAt`	`string (date-time)`	Required
`recipeId`	`string (uuid) \| null`	—
`imageUrl`	`string \| null`	—
`price`	`CandidatePrice \| null`	—

MealCategory

Type

Values

FishMeatPoultryVegetarianVeganSoupPastaTacoLeftoversOther

MovePlanEntryRequest

Property	Type	Required
`toDate`	`string (date)`	Required

OutcomeReason

Type

Values

UnexpectedEventMissingIngredientNotEnoughTimeTooTiredNotAppealingIllnessPlansChangedOtherDidNotLike

or null

OutcomeStatus

Type

Values

CookedCookedWithChangesNotCookedAteElsewhere

PlanCostEstimateResponse

Property	Type	Required
`credits`	`integer (int32)`	Required
`remaining`	`integer (int32)`	Required
`affordable`	`boolean`	Required
`daysToGenerate`	`integer (int32)`	Required
`usesStarterLibrary`	`boolean`	Required
`resetsAt`	`string (date-time)`	Required
`suggestMoreCredits`	`integer (int32)`	—
`preflight`	`PlanPreflightResponse \| null`	—
`affordableNewDishes`	`integer (int32)`	—
`shortfall`	`integer (int32)`	—

PlanDeviationKind

Type

Values

BentSoftNearMissLeftOpenHandPicked

PlanDeviationOptionResponse

Property	Type	Required
`code`	`string`	Required
`date`	`string (date) \| null`	—
`category`	`string \| null`	—
`ruleId`	`string (uuid) \| null`	—

PlanDeviationResponse

Property	Type	Required
`kind`	`PlanDeviationKind`	Required
`rule`	`PlanDeviationRule`	Required
`ruleId`	`string (uuid) \| null`	Required
`date`	`string (date) \| null`	Required
`category`	`string \| null`	Required
`target`	`integer (int32) \| null`	Required
`actual`	`integer (int32) \| null`	Required
`minutes`	`integer (int32) \| null`	Required
`reason`	`string`	Required
`options`	`PlanDeviationOptionResponse[]`	Required
`ingredient`	`string \| null`	—
`memberName`	`string \| null`	—
`constraintKind`	`string \| null`	—
`lockedByHousehold`	`boolean \| null`	—
`capSpent`	`boolean \| null`	—
`priceCeiling`	`PriceCeiling \| null`	—

PlanDeviationRule

Type

Values

CategoryFrequencyMaximumActiveCookingTimeCalendarCapCategoryOnDayCategoryExcludedDaysHardConstraintBabySafePortionDietaryPreferencePriceClassOnDaysRepeatAfterDays

PlanEntryAdaptationResponse

Property	Type	Required
`id`	`string (uuid)`	Required
`fromFoodKey`	`string`	Required
`fromDisplayName`	`string`	Required
`toFoodKey`	`string`	Required
`toDisplayName`	`string`	Required
`quantity`	`number (double)`	Required
`unit`	`string`	Required
`note`	`string \| null`	Required

PlanEntryFeedbackAction

Type

Values

SwappedReplannedVariantOfferedExcludedNotedNothingToSwapTo

PlanEntryFeedbackReason

Type

Values

RuleBrokenTooMuchOfCategoryConstraintNotHonouredTooMuchWorkKidsWontEatNeverAgain

PlanEntryFeedbackRequest

Property	Type	Required
`reason`	`PlanEntryFeedbackReason`	Required
`text`	`string \| null`	—
`memberId`	`string (uuid) \| null`	—

PlanEntryFeedbackResponse

Property	Type	Required
`plan`	`WeeklyPlanResponse`	Required
`result`	`PlanEntryFeedbackResultResponse`	Required

PlanEntryFeedbackResultResponse

Property	Type	Required
`reason`	`PlanEntryFeedbackReason`	Required
`action`	`PlanEntryFeedbackAction`	Required
`broke`	`PlanEntryFeedbackRuleResponse \| null`	—
`category`	`string \| null`	—
`categoryCountBefore`	`integer (int32) \| null`	—
`categoryCountAfter`	`integer (int32) \| null`	—
`memberNames`	`string[] \| null`	—
`previousCandidateId`	`string (uuid) \| null`	—
`newCandidateId`	`string (uuid) \| null`	—
`newTitle`	`string \| null`	—
`newActiveMinutes`	`integer (int32) \| null`	—
`preferenceIds`	`string (uuid)[] \| null`	—
`recipeId`	`string (uuid) \| null`	—
`variantTitle`	`string \| null`	—
`existingVariantId`	`string (uuid) \| null`	—

PlanEntryFeedbackRuleResponse

Property	Type	Required
`rule`	`PlanDeviationRule`	Required
`ruleId`	`string (uuid) \| null`	—
`category`	`string \| null`	—
`minutes`	`integer (int32) \| null`	—
`weekday`	`DayOfWeek \| null`	—
`target`	`integer (int32) \| null`	—
`actual`	`integer (int32) \| null`	—
`ingredient`	`string \| null`	—
`memberName`	`string \| null`	—
`constraintKind`	`string \| null`	—

PlanEntryResponse

Property	Type	Required
`id`	`string (uuid)`	Required
`date`	`string (date)`	Required
`entryType`	`PlanEntryType`	Required
`isLocked`	`boolean`	Required
`portions`	`integer (int32)`	Required
`candidate`	`MealCandidateResponse \| null`	Required
`outcome`	`OutcomeStatus \| null`	—
`outcomeReason`	`OutcomeReason \| null`	—
`outcomeFollowedUpAt`	`string (date-time) \| null`	—
`leftoverFromDates`	`string (date)[] \| null`	—
`leftoverPortions`	`integer (int32) \| null`	—
`lastModifiedByUserId`	`string (uuid) \| null`	—
`lastModifiedByName`	`string \| null`	—
`lastModifiedAt`	`string (date-time) \| null`	—
`servingNotes`	`ServingNoteResponse[] \| null`	—
`servingSummaries`	`ServingSummaryResponse[] \| null`	—
`usedTipIndexes`	`integer (int32)[] \| null`	—
`servingTime`	`string \| null`	—
`adaptations`	`PlanEntryAdaptationResponse[] \| null`	—
`frozenBabyPortions`	`integer (int32) \| null`	—
`newFromRun`	`boolean \| null`	—

PlanEntryType

Type

Values

CookAtHomeEatingOutNoDinnerPlanLeftovers

PlanHeldDish

Property	Type	Required
`date`	`string (date)`	Required
`title`	`string`	Required

PlanningConflictDayResponse

Property	Type	Required
`date`	`string (date)`	Required
`reason`	`string`	Required

PlanningConflictResponse

Property	Type	Required
`code`	`string`	Required
`message`	`string`	Required
`relatedDates`	`string (date)[]`	Required
`suggestedResolution`	`string`	Required
`category`	`string \| null`	—
`requiredCount`	`integer (int32) \| null`	—
`availableCount`	`integer (int32) \| null`	—
`ruleMaximum`	`integer (int32) \| null`	—
`servedCount`	`integer (int32) \| null`	—
`dayReasons`	`PlanningConflictDayResponse[] \| null`	—

PlanOverviewDayResponse

Property	Type	Required
`date`	`string (date)`	Required
`hasDinner`	`boolean`	Required
`entryType`	`PlanEntryType`	Required
`title`	`string \| null`	—

PlanOverviewResponse

Property	Type	Required
`weeks`	`PlanOverviewWeekResponse[]`	Required

PlanOverviewWeekResponse

Property	Type	Required
`weekStart`	`string (date)`	Required
`status`	`PlanStatus`	Required
`days`	`PlanOverviewDayResponse[]`	Required
`hasShoppingList`	`boolean`	—
`shoppedAt`	`string (date-time) \| null`	—
`changedSinceShopped`	`integer (int32)`	—

PlanPickedDish

Property	Type	Required
`date`	`string (date)`	Required
`candidateId`	`string (uuid) \| null`	—
`recipeId`	`string (uuid) \| null`	—

PlanPolicy

Property	Type	Required
`allowGeneration`	`integer (int32) \| null`	—
`allowNearMisses`	`boolean`	—
`categoryCaps`	`RunCategoryCap[] \| null`	—
`reopenDates`	`string (date)[] \| null`	—
`lockedDates`	`string (date)[] \| null`	—
`excludedTitles`	`string[] \| null`	—
`pickedDishes`	`PlanPickedDish[] \| null`	—
`heldDishes`	`PlanHeldDish[] \| null`	—

PlanPreflightBlockedRule

Property	Type	Required
`rule`	`PlanDeviationRule`	Required
`category`	`string \| null`	—
`minutes`	`integer (int32) \| null`	—
`priceCeiling`	`PriceCeiling \| null`	—

PlanPreflightDay

Property	Type	Required
`date`	`string (date)`	Required
`state`	`PlanPreflightDayState`	Required
`title`	`string \| null`	—
`category`	`string \| null`	—
`bend`	`PlanDeviationResponse \| null`	—
`reason`	`PlanPreflightReason \| null`	—
`kept`	`boolean \| null`	—
`usesUp`	`PlanPreflightUseUp[] \| null`	—

PlanPreflightDayState

Type

Values

LibraryGenerateNearMissStaysOpenLockedAnsweredPastEatingOutLeftoversReplaced

PlanPreflightReason

Property	Type	Required
`kind`	`PlanPreflightReasonKind`	Required
`used`	`integer (int32) \| null`	—
`cap`	`integer (int32) \| null`	—
`proposals`	`integer (int32) \| null`	—
`rules`	`PlanPreflightBlockedRule[] \| null`	—

PlanPreflightReasonKind

Type

Values

CapReachedNoCandidateFitsRuleBlocked

PlanPreflightResponse

Property	Type	Required
`days`	`PlanPreflightDay[]`	Required
`nearMissOffer`	`PlanDeviationResponse[]`	Required
`generationCap`	`integer (int32)`	Required
`householdCap`	`integer (int32)`	Required
`alwaysNewDishes`	`boolean`	Required
`nextWeekOnly`	`boolean`	—

PlanPreflightUseUp

Property	Type	Required
`foodKey`	`string`	Required
`displayName`	`string`	Required
`bestBefore`	`string (date) \| null`	Required

PlanRecipeOnDayRequest

Property	Type	Required
`recipeId`	`string (uuid)`	Required
`date`	`string (date)`	Required

PlanRunAccepted

Property	Type	Required
`jobId`	`string (uuid)`	Required
`weekStart`	`string (date)`	Required

PlanRunFailureResponse

Property	Type	Required
`status`	`integer (int32)`	Required
`code`	`string \| null`	Required
`errors`	`PlanningConflictResponse[] \| null`	—
`resetsAt`	`string (date-time) \| null`	—
`scope`	`string \| null`	—
`shortfall`	`integer (int32) \| null`	—

PlanRunState

Type

Values

QueuedRunningDoneFailed

PlanRunStatusResponse

Property	Type	Required
`jobId`	`string (uuid)`	Required
`weekStart`	`string (date)`	Required
`status`	`PlanRunState`	Required
`queuePosition`	`integer (int32) \| null`	Required
`planId`	`string (uuid) \| null`	Required
`startedAt`	`string (date-time)`	Required
`failure`	`PlanRunFailureResponse \| null`	—

PlanStatus

Type

Values

DraftActiveSuperseded

PriceCeiling

Type

Values

CheapCheapOrMid

PriceClass

Type

Values

CheapMidExpensive

PriceSource

Type

Values

ObservedCatalogueTableUnknown

ProblemDetails

Property	Type	Required
`type`	`string \| null`	—
`title`	`string \| null`	—
`status`	`integer (int32) \| null`	—
`detail`	`string \| null`	—
`instance`	`string \| null`	—
`code`	`string \| null`	—

RecipeSectionKind

Type

Values

OwnLinkedUnresolved

ReplacePlanEntryRequest

Property	Type	Required
`mealCandidateId`	`string (uuid) \| null`	—
`entryType`	`PlanEntryType \| null`	—

ReplanScope

Type

Values

OpenDaysWholeWeek

or null

RunCategoryCap

Property	Type	Required
`category`	`MealCategory`	Required
`maxPerWeek`	`integer (int32)`	Required

ServingAudienceKind

Type

Values

PotMemberBabyGuests

ServingNoteResponse

Property	Type	Required
`kind`	`ServingAudienceKind`	Required
`source`	`ServingNoteSource`	Required
`code`	`string`	Required
`text`	`string`	Required
`tags`	`string[]`	Required
`memberId`	`string (uuid) \| null`	—
`memberName`	`string \| null`	—
`stepIndex`	`integer (int32) \| null`	—
`tipIndex`	`integer (int32) \| null`	—
`tipFoods`	`string[] \| null`	—
`rowText`	`string \| null`	—
`lappKind`	`string \| null`	—
`action`	`string \| null`	—
`why`	`string \| null`	—

ServingNoteSource

Type

Values

EngineModel

ServingSummaryResponse

Property	Type	Required
`kind`	`ServingAudienceKind`	Required
`memberId`	`string (uuid) \| null`	Required
`memberName`	`string \| null`	Required
`label`	`string`	Required
`text`	`string`	Required
`fit`	`BabyPortionFit`	Required
`clauses`	`string[]`	Required
`short`	`string \| null`	—

SetFrozenBabyPortionsRequest

Property	Type	Required
`portions`	`integer (int32)`	Required

SetServingTipUsedRequest

Property	Type	Required
`used`	`boolean`	Required

StaleReason

Type

Values

GuestsHouseholdMixed

or null

WeeklyPlanResponse

Property	Type	Required
`id`	`string (uuid)`	Required
`householdId`	`string (uuid)`	Required
`weekStartDate`	`string (date)`	Required
`status`	`PlanStatus`	Required
`plannerVersion`	`string`	Required
`scoreBreakdown`	`map`	Required
`entries`	`PlanEntryResponse[]`	Required
`createdAt`	`string (date-time)`	Required
`activatedAt`	`string (date-time) \| null`	Required
`fromStarterLibrary`	`boolean`	—
`shoppingListStale`	`boolean`	—
`staleDates`	`string (date)[] \| null`	—
`staleReason`	`StaleReason \| null`	—
`deviations`	`PlanDeviationResponse[] \| null`	—