Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.runflow.io/llms.txt

Use this file to discover all available pages before exploring further.

Pricing: $0.04/image. Endpoint: POST /v1/models/reve/edit/runs.
Reve’s edit model lets you upload an existing image and then transform it via a text prompt.

​
Overview

​
Pricing

  • Base price: $0.04/image
  • Note: Per image

​
Reve Edit API

Endpoint: POST /v1/models/reve/edit/runs

​
Run the model

​
Python

import requests

response = requests.post(
    "https://api.runflow.io/v1/models/reve/edit/runs",
    headers={"Authorization": "Bearer RUNFLOW_API_KEY"},
    json={
        "input": {
            "prompt": "Move this entire scene to a rooftop terrace in Tokyo at sunset: the desk is now outdoors on a wooden deck, Tokyo Tower and neon skyscrapers visible in the background, cherry blossom petals floating in the air, warm golden hour light, string lights overhead",
            "image_url": "https://public.runflow.io/images/models/_shared/base-engineer.png"
        },
        "callback_url": "https://your-server.com/webhook"
    },
)

data = response.json()
print(data)

​
Node.js

const response = await fetch(
  "https://api.runflow.io/v1/models/reve/edit/runs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer RUNFLOW_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
        "input": {
            "prompt": "Move this entire scene to a rooftop terrace in Tokyo at sunset: the desk is now outdoors on a wooden deck, Tokyo Tower and neon skyscrapers visible in the background, cherry blossom petals floating in the air, warm golden hour light, string lights overhead",
            "image_url": "https://public.runflow.io/images/models/_shared/base-engineer.png"
        },
        "callback_url": "https://your-server.com/webhook"
    }),
  }
);

const data = await response.json();
console.log(data);

​
cURL

curl -X POST https://api.runflow.io/v1/models/reve/edit/runs \
  -H "Authorization: Bearer $RUNFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
    "input": {
        "prompt": "Move this entire scene to a rooftop terrace in Tokyo at sunset: the desk is now outdoors on a wooden deck, Tokyo Tower and neon skyscrapers visible in the background, cherry blossom petals floating in the air, warm golden hour light, string lights overhead",
        "image_url": "https://public.runflow.io/images/models/_shared/base-engineer.png"
    },
    "callback_url": "https://your-server.com/webhook"
}
JSON

​
Request parameters

ParameterTypeRequiredDescription
inputobjectrequiredModel input parameters. See “Input schema” below.
callback_urlstring | nulloptionalWebhook URL - POSTed when the run reaches a terminal state.
metadataobject | nulloptionalArbitrary key-value pairs attached to the run.

​
Input schema

FieldTypeRequiredAllowed valuesDescription
promptstringrequiredAnyThe text description of how to edit the provided image.
image_urlimagerequiredAnyURL of the reference image to edit. Must be publicly accessible or base64 data URI. Supports PNG, JPEG, WebP, AVIF, and HEIF formats.
num_imagesintegeroptionalAnyNumber of images to generate
output_formatstringoptionalpng, jpeg, webpOutput format for the generated image.
sync_modebooleanoptionalAnyIf True, the media will be returned as a data URI and the output data won’t be available in the request history.

​
Output schema

FieldTypeDescription
outputsjsonUnified output array - one entry per generated artifact with url/type/width/height/duration/etc.
nsfw_detectedjsontrue if the provider flagged output as NSFW, false if cleared, null if not checked.
seedjsonDeterministic seed used for generation, or null if the provider doesn’t return one.
timingjsonProvider timing info (inference_ms etc.), or null.

​
Callback payload

When you provide a callback_url, Runflow POSTs to it once the run reaches a terminal state.
FieldTypeDescription
eventstringEvent type: “run.completed”, “run.failed”, or “run.cancelled”.
run_idstringThe unique identifier of the run.
statusstringTerminal status: “succeeded”, “failed”, or “cancelled”.
outputobject | nullThe run output. Null if the run failed or was cancelled.
duration_msnumber | nullTotal run duration in milliseconds.
created_atstring | nullISO 8601 timestamp when the run was created.
completed_atstring | nullISO 8601 timestamp when the run reached terminal state.
metadataobject | nullThe metadata object passed at run creation, if any.
  • Retries: 3 attempts with exponential backoff (1s, 2s). Retries on 5xx / network errors only.
  • Headers: Runflow-Request-Id is always sent. Runflow-Signature is sent if a signing secret is configured.

​
Additional Resources

Browse all models

Browse the catalog.

Run lifecycle

Callbacks, polling, statuses.

Callbacks

Handle async results.

Pricing

How requests bill out.