Ideogram 4.0 Serverless API
Generate 2K posters and logos with accurate text rendering.
POST /v2/ideogram-4 · 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-4",
9 prompt="A vintage-style travel poster of Tokyo at night, glowing neon signs reflecting on wet streets, a bold title reading \"TOKYO\" across the top and the tagline \"Where Tradition Meets Tomorrow\" below, vibrant teal and magenta palette, clean retro print design",
10 rendering_speed="QUALITY",
11 image_size="square_hd",
12 num_images=1,
13 enable_prompt_expansion=True,
14 output_format="jpeg",
15 seed=123456,
16 enable_safety_checker=True,
17)
18print(result["status"]) # COMPLETED
19print(result.get("output")) # model output (e.g. media URL)
20print(result["metrics"]["inference_time"]) # server compute seconds
21
22# --- Or submit + poll manually (track request_id, control the cadence) ---
23from segmind import SegmindClient, InferenceFailed, InferenceTimeout
24
25client = SegmindClient() # reads SEGMIND_API_KEY
26payload = {
27 "prompt": "A vintage-style travel poster of Tokyo at night, glowing neon signs reflecting on wet streets, a bold title reading \"TOKYO\" across the top and the tagline \"Where Tradition Meets Tomorrow\" below, vibrant teal and magenta palette, clean retro print design",
28 "rendering_speed": "QUALITY",
29 "image_size": "square_hd",
30 "num_images": 1,
31 "enable_prompt_expansion": True,
32 "output_format": "jpeg",
33 "seed": 123456,
34 "enable_safety_checker": True,
35}
36job = client.submit_async("ideogram-4", **payload)
37print(job.request_id) # available immediately
38try:
39 result = job.wait(timeout=600, interval=1.0)
40except InferenceTimeout as e:
41 print("still running:", e.request_id)
42except InferenceFailed as e:
43 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-4",
9 prompt="A vintage-style travel poster of Tokyo at night, glowing neon signs reflecting on wet streets, a bold title reading \"TOKYO\" across the top and the tagline \"Where Tradition Meets Tomorrow\" below, vibrant teal and magenta palette, clean retro print design",
10 rendering_speed="QUALITY",
11 image_size="square_hd",
12 num_images=1,
13 enable_prompt_expansion=True,
14 output_format="jpeg",
15 seed=123456,
16 enable_safety_checker=True,
17)
18print(result["status"]) # COMPLETED
19print(result.get("output")) # model output (e.g. media URL)
20print(result["metrics"]["inference_time"]) # server compute seconds
21
22# --- Or submit + poll manually (track request_id, control the cadence) ---
23from segmind import SegmindClient, InferenceFailed, InferenceTimeout
24
25client = SegmindClient() # reads SEGMIND_API_KEY
26payload = {
27 "prompt": "A vintage-style travel poster of Tokyo at night, glowing neon signs reflecting on wet streets, a bold title reading \"TOKYO\" across the top and the tagline \"Where Tradition Meets Tomorrow\" below, vibrant teal and magenta palette, clean retro print design",
28 "rendering_speed": "QUALITY",
29 "image_size": "square_hd",
30 "num_images": 1,
31 "enable_prompt_expansion": True,
32 "output_format": "jpeg",
33 "seed": 123456,
34 "enable_safety_checker": True,
35}
36job = client.submit_async("ideogram-4", **payload)
37print(job.request_id) # available immediately
38try:
39 result = job.wait(timeout=600, interval=1.0)
40except InferenceTimeout as e:
41 print("still running:", e.request_id)
42except InferenceFailed as e:
43 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/ideogram-4Parameters
promptrequiredstringDescribe the image; put exact in-image text in quotes. More detail improves design and typography.
"A vintage-style travel poster of Tokyo at night, glowing neon signs reflecting on wet streets, a bold title reading \"TOKYO\" across the top and the tagline \"Where Tradition Meets Tomorrow\" below, vibrant teal and magenta palette, clean retro print design"enable_prompt_expansionoptionalbooleanLLM expands your prompt for richer detail. Disable when exact in-image text must stay unchanged.
trueenable_safety_checkeroptionalbooleanFilters unsafe content from outputs. Keep enabled for production and public-facing apps.
trueimage_sizeoptionalstringOutput aspect ratio and resolution. Portrait suits posters, landscape banners, square_hd is default.
"square_hd""square_hd""square""portrait_4_3""portrait_16_9""landscape_4_3""landscape_16_9"num_imagesoptionalintegerImages generated per request, 1 to 8. Raise to compare variations in one call.
1Range: 1 - 8output_formatoptionalstringImage file format. jpeg for smaller files, png for transparency and crisp text edges.
"jpeg""jpeg""png"rendering_speedoptionalstringSpeed/quality tradeoff. Use QUALITY for text-heavy design, TURBO for fast cheap drafts.
"QUALITY""TURBO""BALANCED""QUALITY"seedoptionalintegerRandom seed; -1 randomizes. Fix a value to reproduce the same image across runs.
123456Range: 100 - 999999Response Type
Returns: Text/JSON
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-4Submit — 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