Skip to content
merran
GitHubInstall

Merran documentation API & integrations

Tidy up runs

GET
/api/recipes/tidy
curl --request GET \
--url http://localhost:3000/api/recipes/tidy \
--cookie merran.session_token=<merran.session_token>

The household’s runs that tidy many recipes: going, or finished in the last day, newest first, with how far each got and what it found. And how many recipes are still to tidy. With an API key, it needs the recipes: read permission.

Its runs.

Media typeapplication/json
object
runs
required
Array<object>
object
id
required
string
status
required
string
Allowed values: queued running done failed cancelled
library
required

Every recipe not tidied yet, rather than ones picked.

boolean
total
required
number
done
required
number
suggested
required

Recipes with suggestions waiting in Review.

number
fine
required

Recipes with nothing to change.

number
failed
required
number
stopped
required

Why it stopped before the end, when it did: no AI, this month’s limit, no credit, or three failures in a row.

string | null
startedAt
required
string | null format: date-time
finishedAt
required
string | null format: date-time
untidied
required

How many of its recipes tidy up hasn’t looked at yet.

number

Example

{
"runs": [
{
"id": "0199e8b0-5a10-7a01-8b00-00000000002a",
"status": "running",
"library": true,
"total": 52,
"done": 12,
"suggested": 9,
"fine": 3,
"failed": 0,
"stopped": null,
"startedAt": "2026-10-01T17:30:00.000Z",
"finishedAt": null
}
],
"untidied": 40
}

Not signed in.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

Not allowed.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.