Skip to content

Overlay an image

POST
/v1/process/overlay

Overlay one image on top of another at a specified position. The overlay image is classified for content moderation before processing. Control placement with x/y coordinates and transparency with opacity.

This is a free operation — no credits charged.

object
input_image_url
required

HTTPS URL of the base image.

string
opacity

Overlay opacity (0-1, default 1.0).

null | number
overlay_image_url
required

HTTPS URL of the image to overlay. Must be publicly accessible.

string
x
required

X coordinate for overlay placement (pixels).

integer
y
required

Y coordinate for overlay placement (pixels).

integer

OK

object
content_type

MIME type of the output image.

string
expires_at

ISO 8601 expiry time of the signed URL.

string
image_url

Signed URL of the processed image. Expires in 1 hour.

string
operation

Processing operation performed.

string

Bad Request

object
details
error
string
message
string
request_id
string

Unauthorized

object
details
error
string
message
string
request_id
string

Payment Required

object
details
error
string
message
string
request_id
string

Forbidden

object
details
error
string
message
string
request_id
string

Not Found

object
details
error
string
message
string
request_id
string

Conflict

object
details
error
string
message
string
request_id
string

Unprocessable Entity

object
details
error
string
message
string
request_id
string

Too Many Requests

object
details
error
string
message
string
request_id
string

Unavailable For Legal Reasons

object
details
error
string
message
string
request_id
string

Internal Server Error

object
details
error
string
message
string
request_id
string

Bad Gateway

object
details
error
string
message
string
request_id
string

Service Unavailable

object
details
error
string
message
string
request_id
string