Merran documentation API & integrations

Stop making AI photos

POST

/api/recipes/photos/{runId}/stop

const url = 'http://localhost:3000/api/recipes/photos/0199e8b0-5a10-7a01-8b00-000000000033/stop';
const options = {
  method: 'POST',
  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 POST \
  --url http://localhost:3000/api/recipes/photos/0199e8b0-5a10-7a01-8b00-000000000033/stop \
  --cookie merran.session_token=<merran.session_token>

The photos made stay. The one being made finishes first, so the answer may still say it’s running. With an API key, it needs the recipes: write permission.

Authorizations

session
apiKey

Parameters

Path Parameters

runId

required

string

Example

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

Responses

200

Stopped, or stopping.

application/json

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

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

404

No such run in this household.

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

409

It has already finished.

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