logo
RunComfy

Ideogram 3.0 | Replace Background

ideogram/ideogram-v3/replace-background

Replace backgrounds with prompt-controlled scenes, keeping subjects intact, with adjustable speed, palettes, seeds, and consistent visual coherence.

1. Get started

Use RunComfy's API to run ideogram/ideogram-v3/replace-background. For accepted inputs and outputs, see the model's schema.

curl --request POST \
  --url https://model-api.runcomfy.net/v1/models/ideogram/ideogram-v3/replace-background \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer <token>" \
  --data '{
    "image": "https://playgrounds-storage-public.runcomfy.net/tools/7018/media-files/usecase5-1-input.png",
    "prompt": "Replace background with a moody nighttime city street—wet pavement reflecting warm golden streetlights and deep teal storefront glow, layered graffiti on aged brick walls, soft rain falling under atmospheric haze, distant silhouette of a tram fading into the mist"
  }'

2. Authentication

Set the YOUR_API_TOKEN environment variable with your API key (manage keys in your Profile) and include it on every request as a Bearer token via the Authorization header: Authorization: Bearer $YOUR_API_TOKEN.

3. API reference

Submit a request

Submit an asynchronous generation job and immediately receive a request_id plus URLs to check status, fetch results, and cancel.

curl --request POST \
  --url https://model-api.runcomfy.net/v1/models/ideogram/ideogram-v3/replace-background \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer <token>" \
  --data '{
    "image": "https://playgrounds-storage-public.runcomfy.net/tools/7018/media-files/usecase5-1-input.png",
    "prompt": "Replace background with a moody nighttime city street—wet pavement reflecting warm golden streetlights and deep teal storefront glow, layered graffiti on aged brick walls, soft rain falling under atmospheric haze, distant silhouette of a tram fading into the mist"
  }'

Monitor request status

Fetch the current state for a request_id ("in_queue", "in_progress", "completed", or "cancelled").

curl --request GET \
  --url https://model-api.runcomfy.net/v1/requests/{request_id}/status \
  --header "Authorization: Bearer <token>"

Retrieve request results

Retrieve the final outputs and metadata for the given request_id; if the job is not complete, the response returns the current state so you can continue polling.

curl --request GET \
  --url https://model-api.runcomfy.net/v1/requests/{request_id}/result \
  --header "Authorization: Bearer <token>"

Cancel a request

Cancel a queued job by request_id, in-progress jobs cannot be cancelled.

curl --request POST \
  --url https://model-api.runcomfy.net/v1/requests/{request_id}/cancel \
  --header "Authorization: Bearer <token>"

4. File inputs

Hosted file (URL)

Provide a publicly reachable HTTPS URL. Ensure the host allows server‑side fetches (no login/cookies required) and isn't rate‑limited or blocking bots. Recommended limits: images ≤ 50 MB (~4K), videos ≤ 100 MB (~2–5 min @ 720p). Prefer stable or pre‑signed URLs for private assets.

5. Schema

Input schema

{
  "type": "object",
  "title": "Input",
  "required": [
    "image",
    "prompt"
  ],
  "properties": {
    "image": {
      "title": "Image",
      "description": "",
      "type": "string",
      "default": "https://playgrounds-storage-public.runcomfy.net/tools/7018/media-files/usecase5-1-input.png"
    },
    "prompt": {
      "title": "Prompt",
      "description": "",
      "type": "string",
      "default": "Replace background with a moody nighttime city street—wet pavement reflecting warm golden streetlights and deep teal storefront glow, layered graffiti on aged brick walls, soft rain falling under atmospheric haze, distant silhouette of a tram fading into the mist"
    },
    "magic_prompt": {
      "title": "Magic Prompt",
      "description": "",
      "type": "string",
      "default": "ON",
      "enum": [
        "AUTO",
        "ON",
        "OFF"
      ]
    },
    "seed": {
      "title": "Seed",
      "description": "",
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "default": 70159819
    },
    "rendering_speed": {
      "title": "Rendering Speed",
      "description": "",
      "type": "string",
      "enum": [
        "TURBO",
        "BALANCED",
        "QUALITY"
      ],
      "default": "BALANCED"
    },
    "color_palette": {
      "title": "Color Palette",
      "description": "",
      "type": "object",
      "default": {
        "name": "Ember"
      }
    },
    "style": {
      "title": "Style",
      "description": "",
      "type": "object",
      "default": {
        "style_type": "Auto"
      }
    }
  }
}

Output schema

{
  "output": {
    "type": "object",
    "properties": {
      "image": {
        "type": "string",
        "format": "uri",
        "description": "single image URL"
      },
      "video": {
        "type": "string",
        "format": "uri",
        "description": "single video URL"
      },
      "images": {
        "type": "array",
        "description": "multiple image URLs",
        "items": { "type": "string", "format": "uri" }
      },
      "videos": {
        "type": "array",
        "description": "multiple video URLs",
        "items": { "type": "string", "format": "uri" }
      }
    }
  }
}