Ideogram 3 Reframe Serverless API

Ideogram 3.0's Reframe effortlessly adapts images to diverse formats, enhancing visual content creation for any platform.

~11.29s
POST /v2/ideogram-3-reframe · 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-reframe",
 9    image="https://segmind-resources.s3.amazonaws.com/output/1a759c90-ef73-43dc-b4c0-58c1ae13d2e4-01961465-ffee-4df5-a1cc-4f4fe232f434.png",
10    resolution="1024x1024",
11    rendering_speed="DEFAULT",
12    style_codes=[],
13    style_reference_images=[],
14)
15print(result["status"])                      # COMPLETED
16print(result.get("output"))                  # model output (e.g. media URL)
17print(result["metrics"]["inference_time"])   # server compute seconds
18
19# --- Or submit + poll manually (track request_id, control the cadence) ---
20from segmind import SegmindClient, InferenceFailed, InferenceTimeout
21
22client = SegmindClient()                      # reads SEGMIND_API_KEY
23payload = {
24    "image": "https://segmind-resources.s3.amazonaws.com/output/1a759c90-ef73-43dc-b4c0-58c1ae13d2e4-01961465-ffee-4df5-a1cc-4f4fe232f434.png",
25    "resolution": "1024x1024",
26    "rendering_speed": "DEFAULT",
27    "style_codes": [],
28    "style_reference_images": [],
29}
30job = client.submit_async("ideogram-3-reframe", **payload)
31print(job.request_id)                         # available immediately
32try:
33    result = job.wait(timeout=600, interval=1.0)
34except InferenceTimeout as e:
35    print("still running:", e.request_id)
36except InferenceFailed as e:
37    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/ideogram-3-reframe

Parameters

imagerequired
string (uri)

Image Url used as base input. Use high-resolution links for optimal results.

color_paletteoptional
any | any

A color palette for generation

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

Sets rendering speed. 'DEFAULT' works well for most tasks.

Default: "DEFAULT"
Allowed values :
"TURBO""DEFAULT""QUALITY"
resolutionoptional
string

Choose output resolution. '1024x1024' for balance of quality and efficiency.

Default: "1024x1024"
Allowed values (69 total):
"512x1536""576x1408""576x1472""576x1536""640x1344""640x1408""640x1472""640x1536""704x1152""704x1216"+59 more
seedoptional
integer

Seed for random operations. Use '42' for reproducibility in testing.

Range: 100 - 999999
style_codesoptional
string[]

Apply style codes here. Try ['Modern','Aesthetic'] for artistic results.

style_reference_imagesoptional
string[]

Upload style reference images. Use your favorite artworks for personalization.

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-reframe

    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