Merran documentation API & integrations

A site recipe's photo

GET

/api/sites/recipes/{recipe}/photo

const url = 'http://localhost:3000/api/sites/recipes/0199e8b0-5a10-7a01-8b00-000000000031/photo';
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/sites/recipes/0199e8b0-5a10-7a01-8b00-000000000031/photo \
  --cookie merran.session_token=<merran.session_token>

A small copy, as WebP, fetched once through Merran so browsing doesn’t load photos from other sites. With an API key, it needs the recipes: read permission.

Authorizations

session
apiKey

Parameters

Path Parameters

recipe

required

string

Example

0199e8b0-5a10-7a01-8b00-000000000031

Responses

200

The photo.

image/webp

string format: binary

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

404

No such recipe, or no photo that loads.

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