Skip to main content
POST
Inpaint

Authorizations

X-API-KEY
string
header
required

All API requests require a valid api key. Include your token as a HTTP request header in the following format: X-API-Key: skXXXXXXXXXXXXXXXX. You can obtain an api key by signing up for developer access in your Pixelcut account.

Scopes

pixa:write

Submit editing and generation jobs that consume credits.

Headers

Accept
string

Acceptable response media type(s). application/json, image/*. Default is application/json.

Body

image_url
string<url>
required

URL of the image to be processed.

Example:

"https://cdn3.pixelcut.app/product.jpg"

mask_url
string<url>
required

URL of the mask. It must have the same dimensions as the input image. White pixels mark the area to process; black pixels are kept.

Example:

"https://cdn3.pixelcut.app/product-mask.png"

mode
enum<string>
default:fast

fast (5 credits): quickest results at the lowest cost. generative (10 credits): higher-quality fill with more realistic detail.

Available options:
generative,
fast

Response

Success

result_url
string

A URL to access the resultant image. The file is deleted after at most 24 hours. File format will be the same as the input format.

Example:

"https://assets.pixelcut.app/public/result/a16646be-91c8-4e3a-b359.jpg"