Image Superimpose Serverless API
Superimpose model lets you to create captivating visuals by seamlessly overlaying one image on top of another. It streamlines your image layering process, allowing you to bring your creative vision to life effortlessly.
POST /v2/superimpose · 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 "superimpose",
9 base_image="https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+mock.jpg",
10 overlay_image="https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+logo.png",
11 rescale_factor=0.4,
12 resize_method="nearest-exact",
13 overlay_resize="Resize by rescale_factor",
14 opacity=1,
15 height=1024,
16 width=1024,
17 x_offset=320,
18 y_offset=620,
19 rotation=0,
20 base64=False,
21)
22print(result["status"]) # COMPLETED
23print(result.get("output")) # model output (e.g. media URL)
24print(result["metrics"]["inference_time"]) # server compute seconds
25
26# --- Or submit + poll manually (track request_id, control the cadence) ---
27from segmind import SegmindClient, InferenceFailed, InferenceTimeout
28
29client = SegmindClient() # reads SEGMIND_API_KEY
30payload = {
31 "base_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+mock.jpg",
32 "overlay_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+logo.png",
33 "rescale_factor": 0.4,
34 "resize_method": "nearest-exact",
35 "overlay_resize": "Resize by rescale_factor",
36 "opacity": 1,
37 "height": 1024,
38 "width": 1024,
39 "x_offset": 320,
40 "y_offset": 620,
41 "rotation": 0,
42 "base64": False,
43}
44job = client.submit_async("superimpose", **payload)
45print(job.request_id) # available immediately
46try:
47 result = job.wait(timeout=600, interval=1.0)
48except InferenceTimeout as e:
49 print("still running:", e.request_id)
50except InferenceFailed as e:
51 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 "superimpose",
9 base_image="https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+mock.jpg",
10 overlay_image="https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+logo.png",
11 rescale_factor=0.4,
12 resize_method="nearest-exact",
13 overlay_resize="Resize by rescale_factor",
14 opacity=1,
15 height=1024,
16 width=1024,
17 x_offset=320,
18 y_offset=620,
19 rotation=0,
20 base64=False,
21)
22print(result["status"]) # COMPLETED
23print(result.get("output")) # model output (e.g. media URL)
24print(result["metrics"]["inference_time"]) # server compute seconds
25
26# --- Or submit + poll manually (track request_id, control the cadence) ---
27from segmind import SegmindClient, InferenceFailed, InferenceTimeout
28
29client = SegmindClient() # reads SEGMIND_API_KEY
30payload = {
31 "base_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+mock.jpg",
32 "overlay_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+logo.png",
33 "rescale_factor": 0.4,
34 "resize_method": "nearest-exact",
35 "overlay_resize": "Resize by rescale_factor",
36 "opacity": 1,
37 "height": 1024,
38 "width": 1024,
39 "x_offset": 320,
40 "y_offset": 620,
41 "rotation": 0,
42 "base64": False,
43}
44job = client.submit_async("superimpose", **payload)
45print(job.request_id) # available immediately
46try:
47 result = job.wait(timeout=600, interval=1.0)
48except InferenceTimeout as e:
49 print("still running:", e.request_id)
50except InferenceFailed as e:
51 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/superimposeParameters
base_imagerequiredstring (uri)Base image for the model
"https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+mock.jpg"overlay_imagerequiredstring (uri)Overlay image for the model
"https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+logo.png"base64optionalbooleanBase64 encoding of the output image.
falseheightoptionalintegerHeight
1024maskoptionalstring (uri)Mask for the overlay image
opacityoptionalnumberOpacity of the Overlay Image
1Range: 0 - 1overlay_resizeoptionalstringOverlay Image Resize
"Resize by rescale_factor""Resize by rescale_factor""None""Fit""Resize to width & heigth"rescale_factoroptionalnumberRescale factor for the overlay image
1Range: 0 - 16resize_methodoptionalstringResize Method for Overlay Image.
"nearest-exact""nearest-exact""bilinear""area"rotationoptionalintegerRotation
0Range: 0 - 360widthoptionalintegerWidth
1024x_offsetoptionalintegerX Offset
0y_offsetoptionalintegerY Offset
0Response 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/superimposeSubmit — 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