Ideogram 3.0 Serverless API
Ideogram 3.0 revolutionizes content creation with photorealistic text-to-image generation and diverse aesthetic styles.
POST /v2/ideogram-3 · 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",
9 prompt="A cinematic photograph of a dark forest scene viewed from a distance. In the center, a small patch of glowing plants and flowers is illuminated by a faint, focused glow, casting a soft reflection in a still stream below. The delicate neon-style white text 'Segmind' is softly lit, creating a striking contrast against the deep shadows and mist. The surrounding dense foliage and mist create a mysterious and moody atmosphere, with strong contrast between light and shadow, enhancing the emotional and atmospheric tone.",
10 resolution="1024x1024",
11 rendering_speed="DEFAULT",
12 magic_prompt="AUTO",
13 negative_prompt="No people, no animals.",
14 style_codes=[],
15 style_type="GENERAL",
16)
17print(result["status"]) # COMPLETED
18print(result.get("output")) # model output (e.g. media URL)
19print(result["metrics"]["inference_time"]) # server compute seconds
20
21# --- Or submit + poll manually (track request_id, control the cadence) ---
22from segmind import SegmindClient, InferenceFailed, InferenceTimeout
23
24client = SegmindClient() # reads SEGMIND_API_KEY
25payload = {
26 "prompt": "A cinematic photograph of a dark forest scene viewed from a distance. In the center, a small patch of glowing plants and flowers is illuminated by a faint, focused glow, casting a soft reflection in a still stream below. The delicate neon-style white text 'Segmind' is softly lit, creating a striking contrast against the deep shadows and mist. The surrounding dense foliage and mist create a mysterious and moody atmosphere, with strong contrast between light and shadow, enhancing the emotional and atmospheric tone.",
27 "resolution": "1024x1024",
28 "rendering_speed": "DEFAULT",
29 "magic_prompt": "AUTO",
30 "negative_prompt": "No people, no animals.",
31 "style_codes": [],
32 "style_type": "GENERAL",
33}
34job = client.submit_async("ideogram-3", **payload)
35print(job.request_id) # available immediately
36try:
37 result = job.wait(timeout=600, interval=1.0)
38except InferenceTimeout as e:
39 print("still running:", e.request_id)
40except InferenceFailed as e:
41 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",
9 prompt="A cinematic photograph of a dark forest scene viewed from a distance. In the center, a small patch of glowing plants and flowers is illuminated by a faint, focused glow, casting a soft reflection in a still stream below. The delicate neon-style white text 'Segmind' is softly lit, creating a striking contrast against the deep shadows and mist. The surrounding dense foliage and mist create a mysterious and moody atmosphere, with strong contrast between light and shadow, enhancing the emotional and atmospheric tone.",
10 resolution="1024x1024",
11 rendering_speed="DEFAULT",
12 magic_prompt="AUTO",
13 negative_prompt="No people, no animals.",
14 style_codes=[],
15 style_type="GENERAL",
16)
17print(result["status"]) # COMPLETED
18print(result.get("output")) # model output (e.g. media URL)
19print(result["metrics"]["inference_time"]) # server compute seconds
20
21# --- Or submit + poll manually (track request_id, control the cadence) ---
22from segmind import SegmindClient, InferenceFailed, InferenceTimeout
23
24client = SegmindClient() # reads SEGMIND_API_KEY
25payload = {
26 "prompt": "A cinematic photograph of a dark forest scene viewed from a distance. In the center, a small patch of glowing plants and flowers is illuminated by a faint, focused glow, casting a soft reflection in a still stream below. The delicate neon-style white text 'Segmind' is softly lit, creating a striking contrast against the deep shadows and mist. The surrounding dense foliage and mist create a mysterious and moody atmosphere, with strong contrast between light and shadow, enhancing the emotional and atmospheric tone.",
27 "resolution": "1024x1024",
28 "rendering_speed": "DEFAULT",
29 "magic_prompt": "AUTO",
30 "negative_prompt": "No people, no animals.",
31 "style_codes": [],
32 "style_type": "GENERAL",
33}
34job = client.submit_async("ideogram-3", **payload)
35print(job.request_id) # available immediately
36try:
37 result = job.wait(timeout=600, interval=1.0)
38except InferenceTimeout as e:
39 print("still running:", e.request_id)
40except InferenceFailed as e:
41 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/ideogram-3Parameters
promptrequiredstringThe prompt guides image creation; use detailed descriptions for specific results. Example: 'A futuristic cityscape at sunset.'
"A cinematic photograph of a dark forest scene viewed from a distance. In the center, a small patch of glowing plants and flowers is illuminated by a faint, focused glow, casting a soft reflection in a still stream below. The delicate neon-style white text 'Segmind' is softly lit, creating a striking contrast against the deep shadows and mist. The surrounding dense foliage and mist create a mysterious and moody atmosphere, with strong contrast between light and shadow, enhancing the emotional and atmospheric tone."aspect_ratiooptionalstringAspect ratio formats your image; select '1x1' for square, '16x9' for widescreen.
null"1x3""3x1""1x2""2x1""9x16""16x9""10x16""16x10""2x3""3x2"+5 morecolor_paletteoptionalany | anyA color palette for generation
Preset Color PaletteoptionalanynamerequiredstringCustom Color Paletteoptionalanymembersrequiredobject[]magic_promptoptionalstringMagic Prompt helps enhance descriptions; use 'ON' for complex scenes, 'OFF' for simplicity.
"AUTO""AUTO""ON""OFF"negative_promptoptionalstringExclude elements by specifying negatives; e.g., 'No people, cars'.
"No people, no animals."rendering_speedoptionalstringRendering speed affects time taken; 'TURBO' for faster, 'QUALITY' for detailed results.
"DEFAULT""TURBO""DEFAULT""QUALITY"resolutionoptionalstringResolution affects image detail; higher values for precise detail, lower for speed.
"1024x1024""512x1536""576x1408""576x1472""576x1536""640x1344""640x1408""640x1472""640x1536""704x1152""704x1216"+59 moreseedoptionalintegerThe seed ensures reproducibility; set it for consistent output, omit for variation.
nullRange: 100 - 999999style_codesoptionalstring[]Style codes customize look; use predefined codes for specific styles.
style_typeoptionalstringStyle type influences art style; choose 'REALISTIC' for lifelike, 'DESIGN' for artistic.
"GENERAL""AUTO""GENERAL""REALISTIC""DESIGN"Response 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-3Submit — 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