Image Superimpose

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.

~0.64s

~$0.001

Playground API

Pricing

~0.64s

~$0.001

 1import requests
 2import json
 3
 4url = "https://api.segmind.com/v1/superimpose"
 5headers = {
 6    "x-api-key": "YOUR_API_KEY",
 7    "Content-Type": "application/json"
 8}
 9
10data = {
11    "base_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+mock.jpg",
12    "overlay_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+logo.png",
13    "rescale_factor": 0.4,
14    "resize_method": "nearest-exact",
15    "overlay_resize": "Resize by rescale_factor",
16    "opacity": 1,
17    "height": 1024,
18    "width": 1024,
19    "x_offset": 320,
20    "y_offset": 620,
21    "rotation": 0,
22    "base64": false
23}
24
25response = requests.post(url, headers=headers, json=data)
26
27if response.status_code == 200:
28    result = response.json()
29    print(json.dumps(result, indent=2))
30else:
31    print(f"Error: {response.status_code}")
32    print(response.text)

 1import requests
 2import json
 3
 4url = "https://api.segmind.com/v1/superimpose"
 5headers = {
 6    "x-api-key": "YOUR_API_KEY",
 7    "Content-Type": "application/json"
 8}
 9
10data = {
11    "base_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+mock.jpg",
12    "overlay_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/tshirt+logo.png",
13    "rescale_factor": 0.4,
14    "resize_method": "nearest-exact",
15    "overlay_resize": "Resize by rescale_factor",
16    "opacity": 1,
17    "height": 1024,
18    "width": 1024,
19    "x_offset": 320,
20    "y_offset": 620,
21    "rotation": 0,
22    "base64": false
23}
24
25response = requests.post(url, headers=headers, json=data)
26
27if response.status_code == 200:
28    result = response.json()
29    print(json.dumps(result, indent=2))
30else:
31    print(f"Error: {response.status_code}")
32    print(response.text)

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

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