Frequently Asked Questions
Q: How can I monitor my credit balance?
A: You can track your current credit balance in your API dashboard:
If you want to monitor your credit balance with your own tools, you can do it through this endpoint.
Please note that the credit system used by the API is independent of the Pro subscription that gives access to the Photoroom app on iOS, Android, and the web.
Q: What is the latency to return the processed image?
A: The median latency (number of seconds it will take to remove the background) to return the processed image is 350ms for the Remove Background API.
Q: Does the API have anti-spam / DDoS protection?
Yes, the Photoroom API uses Cloudflare for DDos protection.
Q: Is there a rate-limiting?
A: The default rate limit is 500 images per minute.
When the rate limit has been reached, an error code 429 will be returned.
For special use cases, the rate limit can be increased.
Q: Can I process several images at once, in bulk?
A: Yes, it's possible to process several images in bulk.
While the Photoroom API only processes one image per call, it's totally possible to perform several API calls in parallel.
The only limit is our rate limiting, which is of 500 images / minute (and can be increased for special use cases)
Q: Are the images sent to the API stored by Photoroom? Can I ask to delete them?
A: Photoroom doesn’t save the images that are processed through the Photoroom API.
Q: Where is your server located?
A: The server is located in Eastern USA.
Q: What are the max resolution and size of the image?
A: We recommend limiting images to 25 megapixels for optimal performance.
Maximum File Size: 50MB
Maximum Resolution: 6,000 pixels on the widest side
Maximum File Size: 30MB
Maximum Resolution: 5,000 pixels on the widest side
Please note that large images will result in API calls taking a longer time to complete.
If you experience timeouts, try to increase the default timeout of your networking library.
Q: Which image formats are supported?
A: All APIs accept images in PNG, JPEG and WEBP format. Images in HEIC format are supported only by the Remove Background API. Other formats are not supported.
Q: Which colorspaces are supported?
A: The API supports images using the sRGB colorspace. If you need to process images using a different colorspace (P3, CMYK, etc.) we recommend that you contact us beforehand.
Q: Can I train a machine learning model using images edited with the API or Photoroom?
A: No, according to our terms, you can’t train a machine learning model using the Photoroom API.
Q: What should the Photoroom logo look like within your app with the API partner plan?
A: Below are a few examples of a well-done partnership on an upload image interface. Typically users benefiting from the background removal must see the PhotoRoom logo and be able to click on it.
https://www.loom.com/share/fe97c7e645d94e0586465d98c7326042
From a technical standpoint:
Where should you put the logo in your app? The best place to show the Photoroom logo is on your upload-images UI if you have one. This way creators and resellers can learn about Photoroom. If you don't have such a UI, you can display the attribution logo next to the images you're showing on your application.
Which logo should you use? The Photoroom logo to add is the following one:
We offer several versions of the logo (.svg for Android & Web, .pdf for iOS, and .png), a version with no tagline so you can localize "Background Removed by" and a dark version. They are available here: All PhotoRoom API attributions version. You can add a thin layer with white background and transparency behind our logo, so it works well on all images.
Which link should you set?
Always wrap those images with a link to:
https://photoroom.com for web and email
Q: I have another question
A: For a question on pricing, please check our dedicated pricing FAQ.
For any other technical question, you can reach out to our engineers on our Slack Community.
In case of an integration issue or of a bug on Photoroom's side:
Share with us:
A standalone code to reproduce the bug
The original input image you used
The output image returned by Photoroom API
A detailed description or visual example of the expected image you would have liked to get
We will investigate the issue and come back to you shortly.
Last updated
Was this helpful?