RealDream Lightning Serverless API

RealDream is a sophisticated image generation model utilizing SDXL Lightning architecture. It creates incredibly realistic images from textual prompts. With the ability to excellently generate human portraits from the user's descriptive text.

POST /v2/sdxl1.0-realdream-lightning · 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    "sdxl1.0-realdream-lightning",
 9    prompt="girl in a hat, in a dress Russian patterns, freckles, cornfield, nature background, beautiful landscape, retro style, fashion, magazine cover, professional quality, aesthetics, gentle, beautiful, realism,high detail,high quality, 64k, high resolution, professional photo",
10    negative_prompt="blemishes,(worst quality, low quality, illustration, 3d, 2d, painting, cartoons, sketch), open mouth",
11    samples=1,
12    scheduler="DPM++ SDE",
13    num_inference_steps=8,
14    guidance_scale=1.2,
15    seed=968875,
16    img_width=768,
17    img_height=1152,
18    base64=False,
19)
20print(result["status"])                      # COMPLETED
21print(result.get("output"))                  # model output (e.g. media URL)
22print(result["metrics"]["inference_time"])   # server compute seconds
23
24# --- Or submit + poll manually (track request_id, control the cadence) ---
25from segmind import SegmindClient, InferenceFailed, InferenceTimeout
26
27client = SegmindClient()                      # reads SEGMIND_API_KEY
28payload = {
29    "prompt": "girl in a hat, in a dress Russian patterns, freckles, cornfield, nature background, beautiful landscape, retro style, fashion, magazine cover, professional quality, aesthetics, gentle, beautiful, realism,high detail,high quality, 64k, high resolution, professional photo",
30    "negative_prompt": "blemishes,(worst quality, low quality, illustration, 3d, 2d, painting, cartoons, sketch), open mouth",
31    "samples": 1,
32    "scheduler": "DPM++ SDE",
33    "num_inference_steps": 8,
34    "guidance_scale": 1.2,
35    "seed": 968875,
36    "img_width": 768,
37    "img_height": 1152,
38    "base64": False,
39}
40job = client.submit_async("sdxl1.0-realdream-lightning", **payload)
41print(job.request_id)                         # available immediately
42try:
43    result = job.wait(timeout=600, interval=1.0)
44except InferenceTimeout as e:
45    print("still running:", e.request_id)
46except InferenceFailed as e:
47    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/sdxl1.0-realdream-lightning

Parameters

promptrequired
string

Prompt to render

base64optional
boolean

Base64 encoding of the output image.

Default: false
guidance_scaleoptional
number

Scale for classifier-free guidance

Default: 1.2Range: 1 - 25
img_heightoptional
integer

Can only be 1024 for SDXL

Default: 1024
img_widthoptional
integer

Can only be 1024 for SDXL

Default: 1024
negative_promptoptional
string

blemishes,(worst quality, low quality, illustration, 3d, 2d, painting, cartoons, sketch), open mouth

num_inference_stepsoptional
integer

Number of denoising steps.

Default: 8Range: 1 - 100
samplesoptional
integer

Number of samples to generate.

Default: 1Range: 1 - 4
scheduleroptional
string

Type of scheduler.

Default: "DPM++ SDE"
Allowed values (29 total):
"DPM++ SDE Karras""DPM++ 2M Karras""DPM++ 2M SDE Karras""DPM++ 2M SDE Heun Karras""DPM++ 3M SDE Karras""LMS Karras""DPM2 Karras""DPM2 a Karras""DPM++ 2S a Karras""DPM++ 2M SDE Exponential"+19 more
seedoptional
integer

Seed for image generation.

Default: -1Range: -1 - 999999999999999

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/sdxl1.0-realdream-lightning

    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