# Changelog Here's a walkthrough of the latest API feature: {% embed url="" %} ### 2026-04-21 #### Updated The feature [AI Shadows](https://docs.photoroom.com/image-editing-api-plus-plan/ai-shadows) now supports new parameters that give you complete control over the appearance of the shadow:

shadow.mode=ai.auto-with-overrides
shadow.softnessOverride=0.3
shadow.intensityOverride=0.8
shadow.spreadOverride=medium
shadow.directionOverride=behindLeft
shadow.subjectPoseOverride=upright

shadow.mode=ai.auto-with-overrides
shadow.softnessOverride=0.3
shadow.intensityOverride=0.8
shadow.spreadOverride=medium
shadow.directionOverride=behindRight
shadow.subjectPoseOverride=upright

If you want to give it a try, here's the code to reproduce the first example above: ```bash curl --request POST \ --url https://image-api.photoroom.com/v2/edit \ --header 'x-api-key: YOUR_API_KEY' \ --header 'pr-ai-shadows-model-version: 2026-04-15' \ --form imageFile=@/path/to/your/image.jpg \ --form background.color=FFFFFF \ --form outputSize=1920x1080 \ --form padding=0.15 \ --form shadow.mode=ai.auto-with-overrides \ --form shadow.softnessOverride=0.3 \ --form shadow.softnessOverride: 0.3 \ --form shadow.intensityOverride: 0.8 \ --form shadow.spreadOverride: medium \ --form shadow.directionOverride: behindLeft \ --form shadow.subjectPoseOverride: upright \ --output result-with-deterministic-shadow.png ``` Try it now! More details about the new parameters are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-shadows). ### 2026-03-23 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) now supports placing clothing onto [Virtual Models](https://docs.photoroom.com/image-editing-api-plus-plan/virtual-model):
(original image)(edited image)
If you want to give it a try, here's the code to reproduce the first example above: ```bash curl --request POST \ --url https://image-api.photoroom.com/v2/edit \ --header 'x-api-key: YOUR_API_KEY_HERE' \ --form imageFile=@/path/to/image.png \ --form removeBackground=false \ --form referenceBox=originalImage \ --form virtualModel.mode=ai.auto \ --form virtualModel.model.preset.name=avery \ --form virtualModel.scene.preset.name=street \ --form virtualModel.pose=standing \ --output result.png ``` Try it now! More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/virtual-model). #### Updated The features [Flat Lay](https://docs.photoroom.com/image-editing-api-plus-plan/flat-lay) and [Ghost Mannequin](https://docs.photoroom.com/image-editing-api-plus-plan/ghost-mannequin) have been moved to their own documentation pages. ### 2026-03-19 #### Updated The features [Edit With AI](https://docs.photoroom.com/image-editing-api-plus-plan/edit-with-ai), [AI Beautifier](https://docs.photoroom.com/image-editing-api-plus-plan/ai-beautifier) and [AI Uncrop](https://docs.photoroom.com/image-editing-api-plus-plan/ai-uncrop) now support 2K and 4K resolutions. These resolutions are available only for Enterprise plans: if you're interested to use the 2K or 4K resolutions, please [contact our sales team](https://www.photoroom.com/contact-sales?utm_source=apidocumentation\&utm_medium=enterprisegated). Contact Sales ### 2026-03-16 #### Updated The feature [Create Any Image](https://docs.photoroom.com/image-editing-api-plus-plan/create-any-image) is no longer in [*Alpha*](#user-content-fn-1)[^1] status. ### 2026-02-27 #### Updated The features [Edit With AI](https://docs.photoroom.com/image-editing-api-plus-plan/edit-with-ai) and [AI Beautifier](https://docs.photoroom.com/image-editing-api-plus-plan/ai-beautifier) are no longer in [*Alpha*](#user-content-fn-1)[^1] status. ### 2026-02-26 #### Updated The feature Describe Any Change has been renamed to [Edit With AI](https://docs.photoroom.com/image-editing-api-plus-plan/edit-with-ai). ### 2026-01-19 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) now supports adding a colored outline around the main subject: | *(original image)* | `outline.color=white` | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | | | To add an outline, set the parameter `outline.color` to a solid color value. Here's an example of how to use this new feature: {% code overflow="wrap" %} ```bash curl --request POST \ --url 'https://image-api.photoroom.com/v2/edit' \ --header 'x-api-key: YOUR_API_KEY_HERE' \ --form 'imageFile=@"/path/to/image.png"' \ --form 'outline.color="white"' \ --form 'referenceBox="originalImage"' \ --form 'removeBackground="false"' \ --output result.png ``` {% endcode %} More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/subject-outline). ### 2026-01-06 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) now supports automatically editing the input image by providing a textual description of the changes that you want to make. To use this feature, set the parameter `describeAnyChange.mode` to `ai.auto` **and** use the parameter `describeAnyChange.prompt` to describe the changes:
(original image)(edited image)


describeAnyChange.prompt="Change the shoes color to red"


describeAnyChange.prompt="Remove all the objects on the table"


describeAnyChange.prompt="Remove all the people"
Here's an example of how to use this new feature: ```bash curl --request POST \ --url https://image-api.photoroom.com/v2/edit \ --header 'x-api-key: YOUR_API_KEY_HERE' \ --form imageFile=@/path/to/image.png \ --form removeBackground=false \ --form referenceBox=originalImage \ --form describeAnyChange.mode=ai.auto \ --form describeAnyChange.prompt='Change the shoes color to red' \ --output result.png ``` More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/edit-with-ai). ### 2025-11-06 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) now supports blurring the background of any image: | | | | | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | *(original image)* | `background.blur.mode=bokeh` | `background.blur.mode=gaussian` | | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FQb4CVQZhXwIcKlzxQ9Qp%2Fshoes.jpeg?alt=media\&token=5369cf82-c842-4444-9ab7-1e749b0c4742) |
|
| To blur the background, set the parameters `background.blur.mode=bokeh` and `removeBackground=false`. Here's an example of how to use this new feature: ```bash curl --request POST \ --url https://image-api.photoroom.com/v2/edit \ --header 'x-api-key: YOUR_API_KEY_HERE' \ --form imageFile=@/path/to/image.png \ --form background.blur.mode=bokeh \ --form removeBackground=false \ --output result.png ``` More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/background-blur). #### Updated The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) now offers a new [AI Relight](https://docs.photoroom.com/image-editing-api-plus-plan/ai-relight) mode with stronger color accuracy. To use this new mode, set the parameter `lighting.mode=ai.preserve-hue-and-saturation`: | *Original* | `lighting.mode=ai.auto` | `lighting.mode=ai.preserve-hue-and-saturation` | | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FBXwWQt1XsvEOGvTaQe1M%2Fm43233153640_1.jpg?alt=media\&token=9f48c27c-38af-4fd9-8aff-91291373d0f3) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FgvtEHzukKeAYQefnLIif%2Fold.png?alt=media\&token=0fda2e47-127b-4487-a68c-8c95d1151584) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FCCP27LiwsEj16GadhnMQ%2Fnew.png?alt=media\&token=ca4b3063-018e-464c-a5da-acb0edefdc61) | | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2Fwp0p30v9CVVbGpBNSC7Q%2Fm42770846513_1.jpg?alt=media\&token=e589891f-fccc-4fe7-a5aa-3180dbae58d2) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FoGH7PKtEqmcQ7Q2c3IOI%2Fm42770846513_1.png?alt=media\&token=3d11ecfb-a50a-4f9e-af35-07b21ec7844a) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FkgINLXF3qoE2U3HbkV43%2Fm42770846513_1.png?alt=media\&token=fd49f0aa-fc37-4a9d-bcdb-4a5703ad2758) | | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FcYyU6flKP8ARTJtuadRH%2Fm63703188619_1%20\(1\).jpg?alt=media\&token=8cc24c3c-3b84-4625-8ea0-4fcf471d02b2) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FezLGijQb2hihrjasrwTg%2Fm63703188619_1%20\(1\).png?alt=media\&token=a108a7f7-45d6-4e19-8403-6e2cd9dae415) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2Fmi94UYhBHPbMzhWHdlSq%2Fm63703188619_1%20\(1\).png?alt=media\&token=cc7f28ec-b265-4a8c-84f2-93dd8a59469c) | | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FdfM0951WkWmBpTskwoIl%2Fm84390327592_1.jpg?alt=media\&token=8919997a-d67c-4d97-8201-31bb6361f8a3) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2F6OFjybEH4X3lJJI8kTub%2Fm84390327592_1.png?alt=media\&token=3e0d35b1-8450-45c1-9b7b-15af38680305) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FgKKrdp2hv0BnD6zZPsxJ%2Fm84390327592_1.png?alt=media\&token=c79d4e11-d925-4970-bc43-3ab44ca487af) | | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FUzAdpQlqhyWMfI012OPN%2Fm38165968726_1.jpg?alt=media\&token=c0ac1949-3872-46cd-a423-9db98ade14f7) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FncgQDJfvsDRECtXpY6MG%2Fm38165968726_1.png?alt=media\&token=aa437710-07bd-4e39-8b63-2698881e15d5) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FrOiF44wJEgv32PyiXeu4%2Fm38165968726_1.png?alt=media\&token=330d6df5-291d-4105-a71b-dc7e82f58c2d) | Here's an example of how to use this new feature: ```bash curl --request POST \ --url https://image-api.photoroom.com/v2/edit \ --header 'x-api-key: YOUR_API_KEY' \ --form imageFile=@/path/to/your/image.jpg \ --form referenceBox=originalImage \ --form maxWidth=2000 \ --form maxHeight=2000 \ --form removeBackground=false \ --form lighting.mode=ai.preserve-hue-and-saturation \ --output with-re-lighting.png ``` ### 2025-05-30 #### Added [AI Backgrounds](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds) now supports our new *Studio* model for background generation. This model is better at generating photorealistic images: object shapes are more defined and textures look better. It is also great at generating props such as cutlery or surrounding objects for your scene. While it's slower than our current model, the increase in visual realism and detail make this a worthwhile trade-off for users seeking the highest quality results. Add the `pr-ai-background-model-version: background-studio-beta-2025-03-17` HTTP header to use it, for example: ```bash curl -X POST https://image-api.photoroom.com/v2/edit \ --header 'pr-ai-background-model-version: background-studio-beta-2025-03-17' \ --header 'x-api-key: YOUR_API_KEY' \ --form imageFile=@/path/to/image.jpg \ --form referenceBox=originalImage \ --form 'background.prompt=On the counter of a rustic, artisanal coffee shop' \ --form background.expandPrompt.mode=ai.never \ --output result.jpg ``` Here's a comparison of the new Studio model and the current model:
### 2025-05-19 Updated The default rate limit was updated from 500 to 60 per minute, for new users only. Existing users keep their current rate limit settings. Reach out to request a rate limit update. ### 2025-02-04 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) now supports exporting images in WebP format. To export a WebP image, set the argument `export.format` with the value `webp`. Here's an example of how to use this new feature: {% code overflow="wrap" %} ```bash curl 'https://image-api.photoroom.com/v2/edit?background.color=FFFFFF&outputSize=1000x1000&padding=0.1&export.format=webp&imageUrl=URL_OF_YOUR_IMAGE' \ --header 'x-api-key: YOUR_API_KEY' \ --output result.jpeg ``` {% endcode %} More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/file-size-resolution-and-format). ### 2024-12-19 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) allows you to control the pixel density of the result image. To control the pixel density, set the argument `export.dpi` to a value between `72` and `1200` (included). More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/pixel-density-dpi). #### Updated The interface of [Text-Guided Segmentation](https://docs.photoroom.com/image-editing-api-plus-plan/preview-text-guided-segmentation) has been modified: * the property `segmentation.keepSalientObject=true|false` has been removed * it’s been replaced by the new property `segmentation.mode=keepSalientObject|ignoreSalientObject` ### 2024-09-10 #### Updated [AI Backgrounds](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds) now improves its text prompt by default. To opt-out, set the argument `background.expandPrompt` to `never`. More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds#background.expandprompt). ### 2024-09-02 #### Updated [AI Relighting](https://docs.photoroom.com/image-editing-api-plus-plan/ai-relight) is no longer limited to a maximum image size of 10MB. ### 2024-08-26 #### Added [AI Backgrounds](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds) now supports using both Text and Image prompts at the same time. To use both type of prompts together, set the arguments `background.prompt` and `background.guidance.imageFile` (or `background.guidance.imageUrl`) in your API call:

background.guidance.imageFile=@"/path/to/guidance-image.jpeg"

and

background.prompt="A bottle of perfume rests on the sandy shore of a tranquil beach. The object, partially covered in sand, casts a soft shadow under the warm sunlight. Seashells and driftwood are scattered around, with gentle waves lapping at the shore in the background, creating a serene coastal scene."

background.guidance.imageFile=@"/path/to/guidance-image.jpeg"

and

background.prompt="the image displays a small bottle with a pink substance on a table with a beautiful orange yellow sunset where the clouds are brightly lit from the sunset and a field is in the background slightly blurry."

More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds#using-text-and-image-prompts-together). ### 2024-08-23 #### Added [AI Backgrounds](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds) now supports automatically improving short prompts. To automatically expand your prompt, set the argument `background.expandPrompt` to `auto`:

background.prompt="on a beach"

background.expandPrompt=never

background.prompt="on a beach"

background.expandPrompt=auto

(expanded prompt: "An object rests on the sandy shore of a tranquil beach. The object, partially covered in sand, casts a soft shadow under the warm sunlight. Seashells and driftwood are scattered around, with gentle waves lapping at the shore in the background, creating a serene coastal scene.")

More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds#background.expandprompt). #### Updated [AI Backgrounds](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds) now uses our most recent model (version 3) by default. If you prefer to keep using our previous model (version 2), you can do it by adding the following header to your API call: `pr-ai-background-model-version: 2`. ### 2024-07-23 #### Experiment We’ve started an A/B test of a new [AI Backgrounds v3 model](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds#important-model-selection). The new model should produce better results and is currently being tested on one of our instances. This means that during the day some API calls will use the new model, while others will not. {% hint style="info" %} This only concerns the AI Backgrounds feature, there’s no impact on all the other features. {% endhint %} ### 2024-07-02 #### Added [AI Backgrounds](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds) now supports using an image as a prompt. To use an image prompt, set either the argument `background.guidance.imageFile` or `background.guidance.imageUrl`: | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FlR2xKxVU3FOeO9TsBSOO%2Foriginal.jpeg?alt=media\&token=1fa53df3-8c38-4a3a-a7c9-8a59c3a66f8c) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FPvUi6y7FqySznoAUf27M%2Finspiration.jpg?alt=media\&token=1080133a-e69d-4917-95cf-fdb06b364f2d) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FN9zt58DQJn7NWo1xWk27%2Fresponse-4.png?alt=media\&token=1b9b3b70-dc40-4c8a-a17d-99d986dae65b) | | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | o*riginal image* | *guidance image* | *result* | More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds#image-prompt). #### Updated * Users will no longer lose remaining images when upgrading to a bigger plan. * The [API Playground](https://www.photoroom.com/api/playground) now uses the [latest AI Background model](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds#model-selection). ### 2024-06-12 #### Added * **Use your own background image file**: You can now send your own image file for your backgrounds using `background.imageFile` on the [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan). #### Updated * **Higher resolution**: Previously, the Image Editing API supported image resolutions up to 2000×2000, resulting in a loss of quality. We have enhanced this capability, now allowing images up to 5000×5000 resolution without any quality loss. (Up to 25 Megapixels) * **Margin and Padding**: The API now supports both percentage string values (e.g., "20%") and pixel string values (e.g., "100px"), in addition to the existing percentage values ranging from 0 to 0.49. * **Zapier integration**: AI expand mode has been added. ### 2024-05-30 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) now supports expanding (or un-cropping) an image. To expand an image, set the argument `expand.mode` to the value `ai.auto`. This enables you, for example, to re-use an existing image but with a different aspect ratio: | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2Fspe7s1H6t3zi9YYktv7o%2Finput.png?alt=media\&token=da2cf808-1949-4874-9ea2-49e625cd76a9) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FNk3rLrl1InSZ69BTS5bI%2Fai-expand.png?alt=media\&token=a9733a75-4ef3-4b08-a165-e9e834463247) | | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | *(original image)* | *(expanded image)* | More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-expand). ### 2024-05-22 #### Added * **Sandbox Mode**: You can now make up to 1,000 free API calls by month using our new sandbox mode (100 max per day). Sandbox mode is meant to be used for testing and prototyping, and will produce an image with a watermark. To use sandbox mode, prepend `sandbox_` to your API key. (Example: `sandbox_xxxxxxxxxxxxxxxxxxx`) {% hint style="danger" %} Sandbox mode currently only works with the [Image Editing API](https://docs.photoroom.com/getting-started/broken-reference) (`v2/edit`) {% endhint %} * **Reworked Zapier Integration**: We've completely reworked our [Zapier integration](https://docs.photoroom.com/integrations/how-to-process-images-from-google-drive-using-zapier) for a more seamless and efficient experience. This update adds support of the [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) and improves the reliability of workflows. * **New AI Backgrounds Model**: Switch to the new [AI Backgrounds](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds) model by adding the following HTTP header in your request when calling the [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan):
```http pr-ai-background-model-version=3 ``` | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FigT7dlN9cmlpBHRfeJCr%2Fold-model.png?alt=media\&token=fa81d8e5-00d2-47b3-ace7-b713955f41f2) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2F3wuEmxd58RxHaWLrxFIL%2Fnew-model.png?alt=media\&token=e905f558-5c46-4e2f-9316-a76af7eb5495) | | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | *current model* | *new model* | #### Updated * **Improved `imageUrl` Parsing**: Improved the parsing of `imageUrl` when using GET on the [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) (`v2/edit)`, allowing for a wider range of URLs to be handled correctly. * **Improved Cutout Results**: Enhanced the cutout results for PNG images with significant transparency, providing a cleaner and more accurate outcome. ### 2024-04-03 #### Image Editing API is out of Beta ![:tada:](https://a.slack-edge.com/production-standard-emoji-assets/14.0/apple-medium/1f389.png) We've made an update to the base URL of the [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan). 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](https://docs.photoroom.com/image-editing-api-plus-plan) 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](https://docs.photoroom.com/image-editing-api-plus-plan/ai-text-removal). ### 2024-03-14 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) 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](https://docs.photoroom.com/image-editing-api-plus-plan/positioning#horizontal-and-vertical-alignments). ### 2024-03-04 #### Updated The [API Dashboard](https://app.photoroom.com/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. {% hint style="info" %} 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. {% endhint %} ### 2024-02-22 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) now supports 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: {% code overflow="wrap" %} ```bash 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 ``` {% endcode %} More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/file-size-resolution-and-format). ### 2024-02-01 #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) 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: ```sh 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](https://www.photoroom.com/api/docs/reference/bdfb80d8bcd00-beta-edit-image-v2). #### 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](https://docs.photoroom.com/image-editing-api-plus-plan) can now generate realistic shadows. To add a realistic shadow, set the argument `shadow.mode` with one of the following values:
(original image)ai.softai.hardai.floating
More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-shadows). #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) can now generate realistic backgrounds.
To use this feature set the argument `background.prompt`. More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds). #### Added The [Image Editing API](https://docs.photoroom.com/image-editing-api-plus-plan) 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* | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FNkhQrGGLHn7fbFUuhgox%2Foverexposed-1.jpg?alt=media\&token=7cb6f836-8e3d-4e5a-a1fb-a74833fca0fa) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2Fzv02r2UtPi0SktXoNrxb%2Foverexposed-1.png?alt=media\&token=6d223863-2678-4b2c-b7bd-baf2c58cd8ef) | | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2FMkGu8Kmh2eks1Kx0b2oW%2Funderexposed-1.jpg?alt=media\&token=60a1c5f1-08d7-4931-b5bc-93d0b30e45be) | ![](https://2855892273-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1SYxn7dWbQYsNtUdJE3f%2Fuploads%2F6l6TBwPfrys7a2hX31Oe%2Funderexposed-1.png?alt=media\&token=8994905f-9f5d-4656-b6c9-b8e26ee63de3) | More details about this feature are available on [this page](https://docs.photoroom.com/image-editing-api-plus-plan/ai-relight). ### 2023-12-11 #### Added The [Remove Background API](https://docs.photoroom.com/remove-background-api-basic-plan) 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](https://docs.photoroom.com/remove-background-api-basic-plan/uncertainty-score). ### 2023-11-30 #### Added The [Remove Background API](https://docs.photoroom.com/remove-background-api-basic-plan) 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](https://www.photoroom.com/api/docs/reference/71f4c26e59e43-remove-background). ### 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: ![](https://a.storyblok.com/f/191576/800x433/1366e24029/edit-image-api-playground-demo.gif) Details about this new API are available in our [documentation](https://docs.photoroom.com/getting-started/broken-reference) and [API reference](https://www.photoroom.com/api/docs/reference/87e1c15260b1f-beta-edit-image-v2). ### 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: ```json { "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](https://www.photoroom.com/api/docs/reference/611c03dbcec67-account-details). ### 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: * [Edit Image API reference documentation](https://www.photoroom.com/api/docs/reference/2fffa859aa344-beta-edit-image-v1) * [Generate Background API reference documentation](https://www.photoroom.com/api/docs/reference/24964ec492226-beta-generate-background) ### 2023-06-04 #### Added Add a Changelog page on the documentation [^1]: Features in Alpha status might be deprecated with two week warning. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.photoroom.com/getting-started/changelog.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.