Ideogram 3 Replace Background Serverless API

Effortlessly replace backgrounds in images, enhancing visual storytelling and creativity with precision and speed.

~14.91s
POST /v2/ideogram-3-replace-background · submit + poll
 1# pip install "segmind>=1.1.0"
 2# export SEGMIND_API_KEY="YOUR_API_KEY"
 3import segmind
 4
 5# Async (v2): submit to the queue and block until COMPLETED.
 6# run() returns the final result dict (600s deadline, 1.0s poll by default).
 7result = segmind.run(
 8    "ideogram-3-replace-background",
 9    prompt="Add a forest in the background",
10    image="https://segmind-resources.s3.amazonaws.com/output/085c3d6b-0ecd-4f79-9b41-823c451070f5-ideo-3.png",
11    rendering_speed="DEFAULT",
12    magic_prompt="AUTO",
13    style_codes=[],
14    style_reference_images=[],
15)
16print(result["status"])                      # COMPLETED
17print(result.get("output"))                  # model output (e.g. media URL)
18print(result["metrics"]["inference_time"])   # server compute seconds
19
20# --- Or submit + poll manually (track request_id, control the cadence) ---
21from segmind import SegmindClient, InferenceFailed, InferenceTimeout
22
23client = SegmindClient()                      # reads SEGMIND_API_KEY
24payload = {
25    "prompt": "Add a forest in the background",
26    "image": "https://segmind-resources.s3.amazonaws.com/output/085c3d6b-0ecd-4f79-9b41-823c451070f5-ideo-3.png",
27    "rendering_speed": "DEFAULT",
28    "magic_prompt": "AUTO",
29    "style_codes": [],
30    "style_reference_images": [],
31}
32job = client.submit_async("ideogram-3-replace-background", **payload)
33print(job.request_id)                         # available immediately
34try:
35    result = job.wait(timeout=600, interval=1.0)
36except InferenceTimeout as e:
37    print("still running:", e.request_id)
38except InferenceFailed as e:
39    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/ideogram-3-replace-background

Parameters

imagerequired
string (uri)

Upload the base image for editing. Ensure high resolution for best results.

promptrequired
string

Provides a description for the image creation. Use specific prompts for detailed or themed images.

Default: "Add a forest in the background"
color_paletteoptional
any | any

A color palette for generation

One of:
Preset Color Paletteoptional
any
namerequired
string
Custom Color Paletteoptional
any
membersrequired
object[]
magic_promptoptional
string

Enhance prompts automatically. Choose 'AUTO' for balanced enhancements.

Default: "AUTO"
Allowed values :
"AUTO""ON""OFF"
rendering_speedoptional
string

Adjust speed versus detail. Use 'QUALITY' for highly detailed images.

Default: "DEFAULT"
Allowed values :
"TURBO""DEFAULT""QUALITY"
seedoptional
integer

Sets a reproducible seed for consistency. Keep null for unique results each time.

Default: nullRange: 100 - 999999
style_codesoptional
string[]

Select specific styles to influence the output. Combine for unique aesthetics.

style_reference_imagesoptional
string[]

Use reference images for style influence. Best for specific visual styles.

Response Type

Returns: Image

Asynchronous requests (v2)

Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.

  1. 1
    POST /v2/ideogram-3-replace-background

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • A FAILED request is served as HTTP 422 — the body still carries the error detail.
  • An unknown or expired request_id returns HTTP 404.
  • Results are retained for 1 hour, then expire.
  • Content / RAI blocks surface as FAILED, not a separate state.
  • Track completion by polling the status endpoint.

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out