Segmind SegFit v1.2 Serverless API
SegFit v1.2 creates hyper-realistic virtual try-on images, transforming fashion retail engagement and conversion rates.
POST /v2/segfit-v1.2 · 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.2",
9 outfit_image="https://segmind-resources.s3.amazonaws.com/others/c63e9544-10da-45cd-81f9-725fb98ca0c0-090a11c5-4e9a-42f2-8cf7-d74de7e1ebcf.png",
10 model_image="https://segmind-resources.s3.amazonaws.com/others/be81a5a2-a928-47d2-927e-cdc4cf25cb96-model_1.png",
11 model_type="Balanced",
12 cn_strength=0.35,
13 cn_end=0.35,
14 image_format="png",
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/others/c63e9544-10da-45cd-81f9-725fb98ca0c0-090a11c5-4e9a-42f2-8cf7-d74de7e1ebcf.png",
29 "model_image": "https://segmind-resources.s3.amazonaws.com/others/be81a5a2-a928-47d2-927e-cdc4cf25cb96-model_1.png",
30 "model_type": "Balanced",
31 "cn_strength": 0.35,
32 "cn_end": 0.35,
33 "image_format": "png",
34 "image_quality": 90,
35 "seed": 42,
36 "base64": False,
37}
38job = client.submit_async("segfit-v1.2", **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) 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.2",
9 outfit_image="https://segmind-resources.s3.amazonaws.com/others/c63e9544-10da-45cd-81f9-725fb98ca0c0-090a11c5-4e9a-42f2-8cf7-d74de7e1ebcf.png",
10 model_image="https://segmind-resources.s3.amazonaws.com/others/be81a5a2-a928-47d2-927e-cdc4cf25cb96-model_1.png",
11 model_type="Balanced",
12 cn_strength=0.35,
13 cn_end=0.35,
14 image_format="png",
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/others/c63e9544-10da-45cd-81f9-725fb98ca0c0-090a11c5-4e9a-42f2-8cf7-d74de7e1ebcf.png",
29 "model_image": "https://segmind-resources.s3.amazonaws.com/others/be81a5a2-a928-47d2-927e-cdc4cf25cb96-model_1.png",
30 "model_type": "Balanced",
31 "cn_strength": 0.35,
32 "cn_end": 0.35,
33 "image_format": "png",
34 "image_quality": 90,
35 "seed": 42,
36 "base64": False,
37}
38job = client.submit_async("segfit-v1.2", **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
https://api.segmind.com/v1/segfit-v1.2Parameters
model_imagerequiredstring (uri)Image of the model for try-on. Example: front-facing, well-lit image.
outfit_imagerequiredstring (uri)Image of the outfit to be fitted. Example: a dress or suit.
base64optionalbooleanReturn image as base64 string instead of URL.
falsecn_endoptionalnumberEndpoint for ControlNet's effect. Controls the model body shape, Higher the value, higher the control
0.35Range: 0 - 1cn_strengthoptionalnumberStrength of ControlNet's influence. Maintains the shape of the model.
0.35Range: 0 - 1image_formatoptionalstringOutput image format. 'PNG' is versatile, 'JPEG' compresses well.
"png""png""jpeg""webp"image_qualityoptionalintegerDetermine image quality (1-100). Use 100 for best detail, lower for smaller file size.
90Range: 1 - 100model_typeoptionalstringChoose the generation model type. Use 'Speed' for fast results, 'Quality' for high detail.
"balanced""Speed""Balanced""Quality"seedoptionalintegerEnsures reproducibility. Set to -1 for random variation.
42Range: -1 - 999999Response 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
POST /v2/segfit-v1.2Submit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- 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.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out