Ideogram 3 Replace Background Serverless API
Effortlessly replace backgrounds in images, enhancing visual storytelling and creativity with precision and speed.
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) 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
https://api.segmind.com/v1/ideogram-3-replace-backgroundParameters
imagerequiredstring (uri)Upload the base image for editing. Ensure high resolution for best results.
promptrequiredstringProvides a description for the image creation. Use specific prompts for detailed or themed images.
"Add a forest in the background"color_paletteoptionalany | anyA color palette for generation
Preset Color PaletteoptionalanynamerequiredstringCustom Color Paletteoptionalanymembersrequiredobject[]magic_promptoptionalstringEnhance prompts automatically. Choose 'AUTO' for balanced enhancements.
"AUTO""AUTO""ON""OFF"rendering_speedoptionalstringAdjust speed versus detail. Use 'QUALITY' for highly detailed images.
"DEFAULT""TURBO""DEFAULT""QUALITY"seedoptionalintegerSets a reproducible seed for consistency. Keep null for unique results each time.
nullRange: 100 - 999999style_codesoptionalstring[]Select specific styles to influence the output. Combine for unique aesthetics.
style_reference_imagesoptionalstring[]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
POST /v2/ideogram-3-replace-backgroundSubmit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- 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.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out