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)

API Endpoint

POSThttps://api.segmind.com/v1/superimpose

Parameters

base_imagerequired
string (uri)

Base image for the model

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+mock.jpg"
overlay_imagerequired
string (uri)

Overlay image for the model

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+logo.png"
base64optional
boolean

Base64 encoding of the output image.

Default: false
heightoptional
integer

Height

Default: 1024
maskoptional
string (uri)

Mask for the overlay image

opacityoptional
number

Opacity of the Overlay Image

Default: 1Range: 0 - 1
overlay_resizeoptional
string

Overlay Image Resize

Default: "Resize by rescale_factor"
Allowed values :
"Resize by rescale_factor""None""Fit""Resize to width & heigth"
rescale_factoroptional
number

Rescale factor for the overlay image

Default: 1Range: 0 - 16
resize_methodoptional
string

Resize Method for Overlay Image.

Default: "nearest-exact"
Allowed values :
"nearest-exact""bilinear""area"
rotationoptional
integer

Rotation

Default: 0Range: 0 - 360
widthoptional
integer

Width

Default: 1024
x_offsetoptional
integer

X Offset

Default: 0
y_offsetoptional
integer

Y Offset

Default: 0

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/superimpose

    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