Segmind SegFit v1.3 Serverless API

SegFit v1.3 enables hyper-realistic virtual try-ons, enhancing online fashion retail experiences without physical photoshoots.

PlaygroundHistory
API
Pricing
~37.05s
POST /v2/segfit-v1.3 · 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    "segfit-v1.3",
 9    outfit_image="https://segmind-resources.s3.amazonaws.com/output/217c8192-d055-4fec-b1cf-82325c9cb0b2-segfit-v1.3-outfit.JPG",
10    model_image="https://segmind-resources.s3.amazonaws.com/output/d3539958-a892-455e-b00f-aa46e7cfa70b-segfit-v1.3-ip.png",
11    model_type="Quality",
12    cn_strength=0.8,
13    cn_end=0.5,
14    image_format="jpeg",
15    image_quality=90,
16    seed=42,
17    base64=False,
18)
19print(result["status"])                      # COMPLETED
20print(result.get("output"))                  # model output (e.g. media URL)
21print(result["metrics"]["inference_time"])   # server compute seconds
22
23# --- Or submit + poll manually (track request_id, control the cadence) ---
24from segmind import SegmindClient, InferenceFailed, InferenceTimeout
25
26client = SegmindClient()                      # reads SEGMIND_API_KEY
27payload = {
28    "outfit_image": "https://segmind-resources.s3.amazonaws.com/output/217c8192-d055-4fec-b1cf-82325c9cb0b2-segfit-v1.3-outfit.JPG",
29    "model_image": "https://segmind-resources.s3.amazonaws.com/output/d3539958-a892-455e-b00f-aa46e7cfa70b-segfit-v1.3-ip.png",
30    "model_type": "Quality",
31    "cn_strength": 0.8,
32    "cn_end": 0.5,
33    "image_format": "jpeg",
34    "image_quality": 90,
35    "seed": 42,
36    "base64": False,
37}
38job = client.submit_async("segfit-v1.3", **payload)
39print(job.request_id)                         # available immediately
40try:
41    result = job.wait(timeout=600, interval=1.0)
42except InferenceTimeout as e:
43    print("still running:", e.request_id)
44except InferenceFailed as e:
45    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/segfit-v1.3

Parameters

model_imagerequired
string

Provide the model's image. Ensure good lighting and clear focus.

Exactly one of:
Option 1optional
string (uri)
outfit_imagerequired
string

Upload the outfit image for try-on. Use clear images.

Exactly one of:
Option 1optional
string (uri)
base64optional
boolean

Decide if output is base64 encoded. Set true if needed.

Default: false
cn_endoptional
number

Endpoint of ControlNet effect. Higher values give more influence.

Default: 0.5Range: 0 - 1
cn_strengthoptional
number

Set ControlNet's influence strength. Use higher for more detail.

Default: 0.8Range: 0 - 1
image_formatoptional
string

Select the format for the generated image

Default: "png"
Allowed values :
"png""jpeg""webp"
image_qualityoptional
integer

Adjust image quality. Use 90 for best balance of size and detail.

Default: 90Range: 1 - 100
mask_imageoptional
string

Optional mask image. Use if needed for more control over tryon

Exactly one of:
Option 1optional
string (uri)
model_typeoptional
string

Choose 'Speed' for fast output or 'Quality' for detail.

Default: "Quality"
Allowed values :
"Speed""Balanced""Quality"
seedoptional
integer

Set seed for reproducibility. Use -1 for a random seed.

Default: 42Range: -1 - 999999

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/segfit-v1.3

    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