Grok Imagine Image Serverless API

Text-to-image generation and editing, up to 2K resolution.

~10.34s
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    n=1,
14    output_format="png",
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": "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",
26    "mode": "standard",
27    "aspect_ratio": "16:9",
28    "resolution": "2k",
29    "n": 1,
30    "output_format": "png",
31}
32job = client.submit_async("grok-imagine-image", **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

POSThttps://api.segmind.com/v1/grok-imagine-image

Parameters

promptrequired
string

Text prompt describing the image to generate or the edit to apply. Be specific about subject, lighting, camera, and style.

Default: "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_ratiooptional
string

Output aspect ratio, ignored when an input image sets the size. Use 16:9 landscape, 9:16 social, 1:1 square.

Default: "16:9"
Allowed values (14 total):
"1:1""3:4""4:3""9:16""16:9""2:3""3:2""9:19.5""19.5:9""9:20"+4 more
imageoptional
string (uri)

Optional source image (URL or base64) to edit. Provide it to switch from text-to-image to image-to-image editing.

Default: null
modeoptional
string

Generation mode: standard is fast and economical, quality maximizes fidelity and text rendering. Use quality for final renders.

Default: "standard"
Allowed values :
"standard""quality"
noptional
integer

Number of images per request, 1 to 4. Use 2-3 to compare prompt variations, 1 once dialed in.

Default: 1Range: 1 - 4
output_formatoptional
string

Output file format. Use jpeg for small files, png for lossless, webp for a balance.

Default: "png"
Allowed values :
"jpeg""png""webp"
resolutionoptional
string

Output resolution, 1k or 2k. Use 1k for fast drafts, 2k for detailed final renders.

Default: "2k"
Allowed values :
"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. 1
    POST /v2/grok-imagine-image

    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