Who is this API for?

The Image Editing API enables anyone to easily create high-quality images.

This is what a typical call to the API looks like:

curl --request POST \
  --url https://image-api.photoroom.com/v2/edit \
  --header 'x-api-key: YOUR_API_KEY' \
  --form imageFile=@/absolute/path/to/image.jpg \
  --form removeBackground=true \
  --form background.color=FFFFFF \
  --form padding=0.15 \
  --form shadow.mode=ai.soft \
  --output result-post-endpoint.png

If you don't yet have an apiKey, here are the steps to create yours.

And these are examples of results that this API call produces:

(original image)	(result image)

Let's go over the parameters of this API call.

imageFile=@/absolute/path/to/image.jpg

This parameter represents the input image that you want to edit.

This image can be provided either:

• as a file, using the parameter imageFile

• as a URL, using the parameter imageUrl

More details about maximum file size, resolution and image formats are available here.

removeBackground=true

This parameter specifies that the background of the input image should be removed.

removeBackground is set to true by default, so you can omit it when you want the background to be removed

background.color=FFFFFF

This parameter creates a new background that consists of a white solid color.

Alternatively to using a solid color, you can also opt for:

• having a transparent background (this is this the default behavior)

• using a static image

• creating an AI Background

padding=0.15

This parameter adds 15% of padding around the subject, for a more visually pleasing result.

The positioning of the subject in the result image is fully customizable, you can read more about it here.

shadow.mode=ai.soft

This parameter adds a realistic shadow to the subject, which helps the result image look more natural.

The look of the shadow can be customized, you can read more about it here.