Word2img Serverless API

Create beautifully designed words using Segmind’s word to image for your marketing purposes

~10.00s
PlaygroundAPI
Pricing
POST /v2/w2imgsd1.5-img2img · 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    "w2imgsd1.5-img2img",
 9    image="https://segmind.com/word2img_input.png",
10    prompt="top-view, A mouth-watering pizza topped with gooey cheese and fresh ingredients,Food Photography",
11    negative_prompt="square, poorly drawn, low quality",
12    scheduler="ddim",
13    num_inference_steps=25,
14    guidance_scale=7.5,
15    control_scale=1.9,
16    control_start=0.19,
17    control_end=1,
18    samples=1,
19    seed=6130473235,
20    size=768,
21    base64=False,
22)
23print(result["status"])                      # COMPLETED
24print(result.get("output"))                  # model output (e.g. media URL)
25print(result["metrics"]["inference_time"])   # server compute seconds
26
27# --- Or submit + poll manually (track request_id, control the cadence) ---
28from segmind import SegmindClient, InferenceFailed, InferenceTimeout
29
30client = SegmindClient()                      # reads SEGMIND_API_KEY
31payload = {
32    "image": "https://segmind.com/word2img_input.png",
33    "prompt": "top-view, A mouth-watering pizza topped with gooey cheese and fresh ingredients,Food Photography",
34    "negative_prompt": "square, poorly drawn, low quality",
35    "scheduler": "ddim",
36    "num_inference_steps": 25,
37    "guidance_scale": 7.5,
38    "control_scale": 1.9,
39    "control_start": 0.19,
40    "control_end": 1,
41    "samples": 1,
42    "seed": 6130473235,
43    "size": 768,
44    "base64": False,
45}
46job = client.submit_async("w2imgsd1.5-img2img", **payload)
47print(job.request_id)                         # available immediately
48try:
49    result = job.wait(timeout=600, interval=1.0)
50except InferenceTimeout as e:
51    print("still running:", e.request_id)
52except InferenceFailed as e:
53    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/w2imgsd1.5-img2img

Parameters

imagerequired
string (uri)

Input Image

promptrequired
string

Prompt to render

base64optional
boolean

Base64 encoding of the output image.

Default: false
control_endoptional
number

Scale for controlnet guidance end

Default: 1Range: 0.01 - 1
control_scaleoptional
number

Scale for controlnet conditioning scale

Default: 1.8Range: 0 - 5
control_startoptional
number

Scale for controlnet guidance start

Default: 0.19Range: 0.01 - 1
guidance_scaleoptional
number

Scale for classifier-free guidance

Default: 7.5Range: 0.1 - 25
negative_promptoptional
string

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

num_inference_stepsoptional
integer

Number of denoising steps.

Default: 25Range: 25 - 100
samplesoptional
integer

Number of samples to generate.

Default: 1Range: 1 - 4
scheduleroptional
string

Type of scheduler.

Default: "ddim"
Allowed values :
"ddim""dpmpp_2m"
seedoptional
integer

Seed for image generation.

Default: -1
sizeoptional
integer

Image resolution.

Allowed values :
5127681024

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/w2imgsd1.5-img2img

    Submit — returns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Poll — until COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Result — final response body

Status states

QUEUED— Accepted, waiting for a worker
PROCESSING— Running on a worker
COMPLETED— Done — result body is ready
FAILED— Errored (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