Merran documentation API & integrations

AI photos across the library

GET

/api/recipes/photos

const url = 'http://localhost:3000/api/recipes/photos';
const options = {
  method: 'GET',
  headers: {cookie: 'merran.session_token=<merran.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

How many recipes have no photo, whether AI photos can be made for the household and why not, its photo style, and the latest run making them. With an API key, it needs the recipes: read permission.

Authorizations

session
apiKey

Responses

200

The library.

application/json

object

missing

required

Recipes without a photo.

integer

ready

required

Whether AI photos can be made for the household now.

boolean

why

required

Why not: turned off on the server, or no OpenAI or Google key for the household.

string | null

Allowed values: off noKey

style

required

How the household’s photos look; change it at PATCH /settings/household (photos.style).

string

Allowed values: marble rustic bright moody

run

required

Any of:

object
null

object

required

string

status

required

string

Allowed values: queued running done failed cancelled

total

required

integer

done

required

integer

made

required

integer

failed

required

integer

stopped

required

Why it stopped before the end, when it did.

string | null

startedAt

required

string | null format: date-time

finishedAt

required

string | null format: date-time

Example

{
  "missing": 30,
  "ready": true,
  "why": null,
  "style": "marble",
  "run": {
    "id": "0199e8b0-5a10-7a01-8b00-000000000033",
    "status": "running",
    "total": 30,
    "done": 8,
    "made": 8,
    "failed": 0,
    "stopped": null,
    "startedAt": "2026-10-15T18:30:00.000Z",
    "finishedAt": null
  }
}

401

Not signed in.

application/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."
    }
  }
}

403

Not allowed.

application/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."
    }
  }
}