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.55/request. Endpoint: POST /v1/models/runflow/smart-resize/runs.
Resize an image to a target aspect ratio + resolution (1K, 2K, 4K) without distortion or cropping. Uses generative reframing to recompose the subject into the new frame.

​
Overview

​
Pricing

  • Base price: $0.55/request
  • Note: Per image - smart resize (aspect ratio + resolution)

​
Smart Resize API

Endpoint: POST /v1/models/runflow/smart-resize/runs

​
Run the model

​
Python

import requests

response = requests.post(
    "https://api.runflow.io/v1/models/runflow/smart-resize/runs",
    headers={"Authorization": "Bearer RUNFLOW_API_KEY"},
    json={
        "input": {
            "image_url": "https://public.runflow.io/images/models/runflow/smart-resize/examples/6/before.png",
            "resolution": "1K",
            "aspect_ratio": "4:3"
        },
        "callback_url": "https://your-server.com/webhook"
    },
)

data = response.json()
print(data)

​
Node.js

const response = await fetch(
  "https://api.runflow.io/v1/models/runflow/smart-resize/runs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer RUNFLOW_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
        "input": {
            "image_url": "https://public.runflow.io/images/models/runflow/smart-resize/examples/6/before.png",
            "resolution": "1K",
            "aspect_ratio": "4:3"
        },
        "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/runflow/smart-resize/runs \
  -H "Authorization: Bearer $RUNFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
    "input": {
        "image_url": "https://public.runflow.io/images/models/runflow/smart-resize/examples/6/before.png",
        "resolution": "1K",
        "aspect_ratio": "4:3"
    },
    "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
image_urlimagerequiredAnyURL of the inputs to process - typically a .zip produced by the frontend. bg-brain downloads it to /tmp/inputs/ and unzips with filenames preserved. HTTPS required.
aspect_ratiostringrequiredAnyTarget output aspect ratio. Examples: “1:1” (square), “16:9” (widescreen), “9:16” (portrait), “4:3”, “3:4”, “21:9” (cinematic), “2:3”, “3:2”.
resolutionstringrequired1K, 2K, 4KTarget output resolution tier. “1K” ≈ 1024px, “2K” ≈ 2048px, “4K” ≈ 4096px on the long side.

​
Output schema

FieldTypeDescription
outputsjsonArray of result items, each with at minimum a url field.
seedjsonRandom seed used (null if N/A).
timingjsonProvider timing breakdown (null if not surfaced).
nsfw_detectedjsonProvider NSFW flag (null if not surfaced).

​
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.