Fashion AI Serverless API

This model is capable of editing clothing in an image using a premier clothing segmentation algorithm.

~63.99s
POST /v2/fashion-ai · 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    "fashion-ai",
 9    image="https://segmind-sd-models.s3.amazonaws.com/display_images/Fai_ip.png.png",
10    prompt="a person wearing blue jeans",
11    clothing="topwear",
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    "image": "https://segmind-sd-models.s3.amazonaws.com/display_images/Fai_ip.png.png",
23    "prompt": "a person wearing blue jeans",
24    "clothing": "topwear",
25}
26job = client.submit_async("fashion-ai", **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/fashion-ai

Parameters

imagerequired
string (uri)

Input image to in-paint. The image will be center cropped and resized to size 512*512.

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/Fai_ip.png.png"
promptrequired
string

Image prompt that will edit the clothing.

Default: "a person wearing blue jeans"
clothingoptional
string

This value should be one of the following - [topwear, bottomwear]

Default: "topwear"

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/fashion-ai

    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