API Reference

Clean up

post
https://api.jasper.ai/v1/image/cleanup

Remove unwanted elements from an image using a mask to specify areas to clean

📘

Get Started with Image API

To use Jasper's Image endpoints, you'll need an API key. Image API access is available for customers on the Jasper Business plan with an API subscription.

Already a Business customer? Generate your API key in Settings → API Tokens.

New to Jasper? Request API access →

Cleanup now supports RGBA images. Read the native RGBA object removal blog post for more details.

LLM friendly version

Body Params

Image file upload and mask file upload
Size of an image uploaded must not exceed 30MB and resolution must not exceed 16 mega-pixels
Size of a mask uploaded must not exceed 30MB and resolution must not exceed 16 mega-pixels
Both image and mask must have the same size

file

The image to be cleaned

file

The mask indicating areas to clean
The mask should be black and white with no grey pixels (e.g. values of only 0 or 255), the value of 0 indicating a pixel to keep as is and 255 a pixel to 'clean up'

Responses
200

The image was successfully cleaned.

400

Bad request. May be missing required inputs or may have badly formatted inputs or options.

500

Internal server error. Unable to clean image.

Updated 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 2 months ago