Grok Imagine Image Serverless API
Text-to-image generation and editing, up to 2K resolution.
POST /v2/grok-imagine-image · 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 "grok-imagine-image",
9 prompt="A majestic snow leopard perched on a rocky cliff at dawn, golden sunlight catching its thick fur, breath visible in the cold air, sweeping Himalayan mountain range in the background, ultra-detailed wildlife photography, sharp focus, dramatic natural lighting",
10 mode="standard",
11 aspect_ratio="16:9",
12 resolution="2k",
13)
14print(result["status"]) # COMPLETED
15print(result.get("output")) # model output (e.g. media URL)
16print(result["metrics"]["inference_time"]) # server compute seconds
17
18# --- Or submit + poll manually (track request_id, control the cadence) ---
19from segmind import SegmindClient, InferenceFailed, InferenceTimeout
20
21client = SegmindClient() # reads SEGMIND_API_KEY
22payload = {
23 "prompt": "A majestic snow leopard perched on a rocky cliff at dawn, golden sunlight catching its thick fur, breath visible in the cold air, sweeping Himalayan mountain range in the background, ultra-detailed wildlife photography, sharp focus, dramatic natural lighting",
24 "mode": "standard",
25 "aspect_ratio": "16:9",
26 "resolution": "2k",
27}
28job = client.submit_async("grok-imagine-image", **payload)
29print(job.request_id) # available immediately
30try:
31 result = job.wait(timeout=600, interval=1.0)
32except InferenceTimeout as e:
33 print("still running:", e.request_id)
34except InferenceFailed as e:
35 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 "grok-imagine-image",
9 prompt="A majestic snow leopard perched on a rocky cliff at dawn, golden sunlight catching its thick fur, breath visible in the cold air, sweeping Himalayan mountain range in the background, ultra-detailed wildlife photography, sharp focus, dramatic natural lighting",
10 mode="standard",
11 aspect_ratio="16:9",
12 resolution="2k",
13)
14print(result["status"]) # COMPLETED
15print(result.get("output")) # model output (e.g. media URL)
16print(result["metrics"]["inference_time"]) # server compute seconds
17
18# --- Or submit + poll manually (track request_id, control the cadence) ---
19from segmind import SegmindClient, InferenceFailed, InferenceTimeout
20
21client = SegmindClient() # reads SEGMIND_API_KEY
22payload = {
23 "prompt": "A majestic snow leopard perched on a rocky cliff at dawn, golden sunlight catching its thick fur, breath visible in the cold air, sweeping Himalayan mountain range in the background, ultra-detailed wildlife photography, sharp focus, dramatic natural lighting",
24 "mode": "standard",
25 "aspect_ratio": "16:9",
26 "resolution": "2k",
27}
28job = client.submit_async("grok-imagine-image", **payload)
29print(job.request_id) # available immediately
30try:
31 result = job.wait(timeout=600, interval=1.0)
32except InferenceTimeout as e:
33 print("still running:", e.request_id)
34except InferenceFailed as e:
35 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/grok-imagine-imageParameters
promptrequiredstringDescribe the image to generate or the edit to apply. Be specific about subject, lighting, camera, and style.
"A majestic snow leopard perched on a rocky cliff at dawn, golden sunlight catching its thick fur, breath visible in the cold air, sweeping Himalayan mountain range in the background, ultra-detailed wildlife photography, sharp focus, dramatic natural lighting"aspect_ratiooptionalstringOutput aspect ratio. Ignored when an input image sets the size.
"16:9""1:1""3:4""4:3""9:16""16:9""2:3""3:2""9:19.5""19.5:9""9:20"image_urlsoptionalstring[]Optional source images to edit. Up to 3 — reference multiple as <IMAGE_0>, <IMAGE_1>, <IMAGE_2> in the prompt. Providing any image switches from generation to editing (and edit pricing). Omit for pure text-to-image.
[]modeoptionalstringStandard is fast and economical; quality maximizes fidelity and text rendering. Also affects price.
"standard""standard""quality"noptionalintegerImages to generate per request, 1 to 4. Price scales with the number of images returned.
1Range: 1 - 4output_formatoptionalstringOutput file format.
"png""jpeg""png""webp"resolutionoptionalstringOutput resolution. 1k for fast drafts, 2k for detailed final renders.
"2k""1k""2k"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/grok-imagine-imageSubmit — 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