GPT Image 2 Serverless API

Generate photorealistic images with legible multilingual text and 2K output.

POST /v2/gpt-image-2 · 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    "gpt-image-2",
 9    prompt="A photorealistic, cinematic shot of a cozy independent bookstore in Mumbai at golden hour. Warm afternoon sunlight streams through a tall front window onto wooden shelves packed with books; book spines are clearly visible with titles in English and Hindi Devanagari script. In the foreground, a handwritten chalkboard A-frame easel reads, in clean legible chalk lettering: first line 'मुंबई पुस्तक भंडार', second line 'Mumbai Book Store', and a smaller third line 'Open Daily  9 am – 9 pm'. Shallow depth of field, shot on a full-frame camera at 35mm f/2.0, ultra-realistic detail, natural color grading, dust motes in sunlight, film grain.",
10    size="1536x1024",
11    quality="high",
12)
13print(result["status"])                      # COMPLETED
14print(result.get("output"))                  # model output (e.g. media URL)
15print(result["metrics"]["inference_time"])   # server compute seconds
16
17# --- Or submit + poll manually (track request_id, control the cadence) ---
18from segmind import SegmindClient, InferenceFailed, InferenceTimeout
19
20client = SegmindClient()                      # reads SEGMIND_API_KEY
21payload = {
22    "prompt": "A photorealistic, cinematic shot of a cozy independent bookstore in Mumbai at golden hour. Warm afternoon sunlight streams through a tall front window onto wooden shelves packed with books; book spines are clearly visible with titles in English and Hindi Devanagari script. In the foreground, a handwritten chalkboard A-frame easel reads, in clean legible chalk lettering: first line 'मुंबई पुस्तक भंडार', second line 'Mumbai Book Store', and a smaller third line 'Open Daily  9 am – 9 pm'. Shallow depth of field, shot on a full-frame camera at 35mm f/2.0, ultra-realistic detail, natural color grading, dust motes in sunlight, film grain.",
23    "size": "1536x1024",
24    "quality": "high",
25}
26job = client.submit_async("gpt-image-2", **payload)
27print(job.request_id)                         # available immediately
28try:
29    result = job.wait(timeout=600, interval=1.0)
30except InferenceTimeout as e:
31    print("still running:", e.request_id)
32except InferenceFailed as e:
33    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/gpt-image-2

Parameters

promptrequired
string

Text describing the image. Supports in-image typography across scripts — lead with subject, style, lighting.

Default: "A photorealistic, cinematic shot of a cozy independent bookstore in Mumbai at golden hour. Warm afternoon sunlight streams through a tall front window onto wooden shelves packed with books; book spines are clearly visible with titles in English and Hindi Devanagari script. In the foreground, a handwritten chalkboard A-frame easel reads, in clean legible chalk lettering: first line 'मुंबई पुस्तक भंडार', second line 'Mumbai Book Store', and a smaller third line 'Open Daily 9 am – 9 pm'. Shallow depth of field, shot on a full-frame camera at 35mm f/2.0, ultra-realistic detail, natural color grading, dust motes in sunlight, film grain."
backgroundoptional
string

"Opaque" for full scenes; "transparent" for logos, stickers, and product cutouts.

Default: "opaque"
Allowed values :
Opaque"opaque"
Transparent"transparent"
Auto"auto"
image_urlsoptional
string[]

Optional reference images to edit or draw context from. Providing any image switches to edit mode.

Default: []
mask_image_urloptional
string (uri)

Optional mask for surgical inpainting. White regions of the mask are edited; everything outside stays pixel-perfect. Only used with reference images.

moderationoptional
string

Content filter strictness. "Auto" is the safe default.

Default: "auto"
Allowed values :
Low"low"
Auto"auto"
output_compressionoptional
integer

Compression level 0-100. 100 preserves text crispness; lower values reduce file size.

Default: 100Range: 0 - 100
output_formatoptional
string

"PNG" for crisp text, "WEBP" for smaller size, "JPEG" for broad compatibility.

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

Rendering fidelity. "High" keeps typography crisp; use lower values only for previews.

Default: "high"
Allowed values :
Low"low"
Medium"medium"
High"high"
Auto"auto"
sizeoptional
string

Output resolution (WIDTHxHEIGHT). "Auto" lets the model pick.

Default: "1536x1024"
Allowed values (13 total):
"1024x1024""1536x1024""1024x1536""1280x960""960x1280""1536x864""864x1536""2048x2048""2048x1152""1152x2048"+3 more

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. 1
    POST /v2/gpt-image-2

    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