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)

API Endpoint

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

Parameters

promptrequired
string

Describe 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.

Default: "16:9"
Allowed values (14 total):
Square (1:1)"1:1"
Portrait (3:4)"3:4"
Landscape (4:3)"4:3"
Vertical (9:16)"9:16"
Widescreen (16:9)"16:9"
Portrait (2:3)"2:3"
Landscape (3:2)"3:2"
Tall (9:19.5)"9:19.5"
Wide (19.5:9)"19.5:9"
Very tall (9:20)"9:20"
+4 more
image_urlsoptional
string[]

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.

Default: []
modeoptional
string

Standard is fast and economical; quality maximizes fidelity and text rendering. Also affects price.

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

Images to generate per request, 1 to 4. Price scales with the number of images returned.

Default: 1Range: 1 - 4
output_formatoptional
string

Output file format.

Default: "png"
Allowed values :
JPEG"jpeg"
PNG"png"
WEBP"webp"
resolutionoptional
string

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

Default: "2k"
Allowed values :
1K"1k"
2K"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