Changelog

History of the changes made to the Photoroom API

2024-03-04

Image Editing API is out of Beta

We've made an update to the base URL of the Image Editing API.

The previous base URL beta-sdk.photoroom.com has been updated to image-api.photoroom.com.

This change aims to enhance the clarity and consistency of our image API services.

Old base URL: beta-sdk.photoroom.com
New base URL: image-api.photoroom.com

Required Actions

Update the base URL: Please update all instances of the old base URL in your projects to the new base URL: image-api.photoroom.com.
Test and Validate: After updating, make sure to test your integrations to confirm everything is working as expected with the new base URL.
Deadline: The transition should be completed by the 5th of July 2024, after which the old base URL will no longer be operational.

2024-04-02

Added

The Image Editing API can now automatically remove text from an image.

To remove text from the input image, set the argument textRemoval.mode with one of the following values:

ai.artificial: artificial text will be automatically removed. Artificial text includes all text added on an image through post-precessing, such as company name, watermarks, discounts, etc.
ai.natural: natural text will be automatically removed. Natural text includes text that naturally occurs in an image such as writing on buildings or clothings, road signs, etc.
ai.all: all text (natural and artificial) will be automatically removed.

(original image)

ai.artificial

ai.natural

ai.all

More details about this feature are available on this page.

2024-03-14

Added

The Image Editing API now allows you to manually control the horizontal and/or vertical alignments of the subject.

Manually controlling the alignment is very useful when you want to position subjects with different aspect ratios is a harmonious way, like here where the subjects have been vertically aligned at the bottom:

More details about manually controlling the subject alignments are available on this page.

2024-03-04

Updated

The API Dashboard in the Photoroom Web App has been moved.

The API Dashboard used to be accessible from Your personal space, and it has now been moved to My Photoroom API team.

To switch to My Photoroom API team, use the Team Switcher that's on the top left of the app:

Moving the API Dashboard to My Photoroom API team makes it possible for you to share access to your API Dashboard with your teammates.

Please note that this change has no effect on existing API Keys.

Existing API Keys are still valid and you don't need to make any change to your code.

2024-02-22

Added

The Image Editing API now support exporting images in JPEG format.

To export a JPEG image, set the argument export.format with the value jpeg.

Here's an example of how to use this new feature:

curl 'https://image-api.photoroom.com/v2/edit?background.color=FFFFFF&outputSize=1000x1000&padding=0.1&export.format=jpeg&imageUrl=URL_OF_YOUR_IMAGE' \
  --header 'x-api-key: YOUR_API_KEY' \
  --output result.jpeg

More details about this feature are available on this page.

2024-02-01

Added

The Image Editing API now supports a POST route, which allows you to directly upload an image file rather than sending the URL of an image.

Here's an example how to call this new route:

curl --request POST \
  --url https://image-api.photoroom.com/v2/edit \
  --header 'Accept: image/png, application/json' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: YOUR_API_KEY' \
  --form imageFile=@/absolute/path/to/image.jpg \
  --form shadow.mode=ai.soft \
  --form background.color=FFFFFF \
  --form padding=0.1 \
  --output res.png

Detailed specifications are available in the API reference.

Updated

The “Edit Image API” has been renamed to “Image Editing API”.

Please note that this is only a change of the commercial name: all of the technical identifiers (HTTP endpoint, argument names, etc.) are still the same.

2024-01-05

Added

The Image Editing API can now generate realistic shadows.

To add a realistic shadow, set the argument shadow.mode with one of the following values:

(original image)

ai.soft

ai.hard

ai.floating

More details about this feature are available on this page.

Added

The Image Editing API can now generate realistic backgrounds.

To use this feature set the argument background.prompt.

More details about this feature are available on this page.

Added

The Image Editing API can now re-light the subject of an image.

To re-light the subject of an image, set the argument lighting.mode=ai.auto.

Original

Re-lighted

More details about this feature are available on this page.

2023-12-11

Added

The Remove Background API now returns an uncertainty score.

The score reflects the confidence of the model in the cutout and is returned through the HTTP header x-uncertainty-score of the response.

More details about the uncertainty score are available on this page.

2023-11-30

Added

The Remove Background API now supports WebP format for the result image.

To output a WebP image, set the argument format to webp.

Detailed specifications and usage instructions are available on our API reference.

2023-10-16

Added

New Endpoint - Edit Image v2: We have introduced a new beta endpoint GET /v2/edit that enables you to apply complex edits to an image.

This new endpoint comes with an interactive playground that lets you configure your API call and preview the result in real time:

Details about this new API are available in our documentation and API reference.

2023-06-26

Added

New Endpoint - Account Details: We have introduced a new endpoint GET /v1/account which provides detailed information about the current state of your account.

This includes your current credit consumption and the total monthly credits available for your subscription.

This new endpoint is aimed at giving users a better understanding of their account status and managing their credit usage effectively.

The response from the endpoint will be in JSON format, as shown in the example below:

{ "credits": { "available": 9912, "subscription": 10000 } }

In this sample, available denotes the remaining credits for the current month and subscription indicates the total monthly credits associated with the user's subscription.

Detailed specifications and usage instructions are available on our API reference.

2023-06-05

Added

Image Upload Enhancement: We have made improvements to our API's image upload functionality to offer a more flexible experience. In addition to passing an imageUrl as a URL parameter, users are now also able to send the image binary directly in a POST request using the new imageFile field. This added capability simplifies the process of uploading images, especially for those who have the images available locally and not hosted online.

The previous method using imageUrl remains functional and backward compatibility is maintained. Users are free to choose the method most convenient to their needs.

Please refer to our updated documentation for detailed instructions on using the new imageFile field: