Kandinsky 2.1 Serverless API

Kandinsky inherits best practices from Dall-E 2 and Latent diffusion, while introducing some new ideas.

~0.00s
POST /v2/kandinsky2.1-txt2im · 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    "kandinsky2.1-txt2im",
 9    prompt="tiny isometric city on a tiny floating island, highly detailed, 3d render",
10    negative_prompt="NONE",
11    scheduler="DDIM",
12    samples=1,
13    num_inference_steps=25,
14    guidance_scale=7.5,
15    seed=1024,
16    img_width=512,
17    img_height=512,
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": "tiny isometric city on a tiny floating island, highly detailed, 3d render",
30    "negative_prompt": "NONE",
31    "scheduler": "DDIM",
32    "samples": 1,
33    "num_inference_steps": 25,
34    "guidance_scale": 7.5,
35    "seed": 1024,
36    "img_width": 512,
37    "img_height": 512,
38    "base64": False,
39}
40job = client.submit_async("kandinsky2.1-txt2im", **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/kandinsky2.1-txt2im

Parameters

base64optional
boolean

Base64 encoding of the output image.

Default: false
guidance_scaleoptional
number

Scale for classifier-free guidance

img_heightoptional
integer

Image resolution.

Allowed values :
5121024
img_widthoptional
integer

Image resolution.

Allowed values :
5121024
negative_promptoptional
string

Prompts to exclude, eg. 'bad anatomy, bad hands, missing fingers'

num_inference_stepsoptional
integer

Number of denoising steps.

Range: 10 - 40
promptoptional
string

Prompt to render

samplesoptional
integer

Number of samples to generate.

Default: 1Range: 1 - 8
scheduleroptional
string

Type of scheduler.

Allowed values :
"DDIM""P-Sampler"
seedoptional
integer

Seed for image generation.

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/kandinsky2.1-txt2im

    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