Image Superimpose V2 Serverless API

Superimpose V2 elevates image editing! Seamlessly layer images with background removal, precise positioning, and flexible resizing options. Explore 14 blending modes to create stunning effects

POST /v2/superimpose-v2 · 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-v2",
 9    base_image="https://segmind-sd-models.s3.amazonaws.com/display_images/superimpose-v2-model.jpeg",
10    overlay_image="https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt-logo-2.png",
11    rescale_factor=0.4,
12    resize_method="nearest",
13    bg_remove_model="Bria",
14    blend_mode="screen",
15    opacity=90,
16    x_percent=50,
17    y_percent=65,
18    rotation=0,
19    base64=False,
20)
21print(result["status"])                      # COMPLETED
22print(result.get("output"))                  # model output (e.g. media URL)
23print(result["metrics"]["inference_time"])   # server compute seconds
24
25# --- Or submit + poll manually (track request_id, control the cadence) ---
26from segmind import SegmindClient, InferenceFailed, InferenceTimeout
27
28client = SegmindClient()                      # reads SEGMIND_API_KEY
29payload = {
30    "base_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/superimpose-v2-model.jpeg",
31    "overlay_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt-logo-2.png",
32    "rescale_factor": 0.4,
33    "resize_method": "nearest",
34    "bg_remove_model": "Bria",
35    "blend_mode": "screen",
36    "opacity": 90,
37    "x_percent": 50,
38    "y_percent": 65,
39    "rotation": 0,
40    "base64": False,
41}
42job = client.submit_async("superimpose-v2", **payload)
43print(job.request_id)                         # available immediately
44try:
45    result = job.wait(timeout=600, interval=1.0)
46except InferenceTimeout as e:
47    print("still running:", e.request_id)
48except InferenceFailed as e:
49    print("failed:", e.detail)

API Endpoint

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

Parameters

base_imagerequired
string (uri)

Base image for the model

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/superimpose-v2-model.jpeg"
overlay_imagerequired
string (uri)

Overlay image for the model

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

Base64 encoding of the output image.

Default: false
bg_remove_modeloptional
string

BG Removal Model

Default: "Bria"
Allowed values :
"Bria""IsNet""None"
blend_modeoptional
string

Blend Mode

Default: "multiply"
Allowed values (14 total):
"multiply""normal""dissolve""darken""lighten""screen""overlay""soft light""hard light""vivid light"+4 more
maskoptional
string (uri)

background removal mask for the overlay image

Default: null
mirroroptional
string

Mirror

Allowed values :
"None""horizontal""vertical"
opacityoptional
number

Opacity of the Overlay Image

Default: 90Range: 0 - 100
rescale_factoroptional
number

Rescale factor for the overlay image

Default: 1Range: 0 - 100
resize_methodoptional
string

Resize Method for Overlay Image.

Default: "nearest"
Allowed values :
"nearest""box""bilinear""bicubic""lanczos"
rotationoptional
integer

Rotation

Default: 0Range: 0 - 360
Allowed values :
0
x_percentoptional
integer

X Percent

Default: 50Range: 0 - 100
y_percentoptional
integer

Y Percent

Default: 80Range: 0 - 100

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-v2

    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