Photoroom API Documentation
  • 🔑Get your API key
  • 🙋Get Support via Slack
  • 📚API Reference (OpenAPI)
  • Getting Started
    • How does the API work?
    • Which API should I use?
    • How can I get my API key?
    • Can I get free API calls?
    • How do I make my first API call?
    • Which AI features are available in the API?
    • How do I integrate the API into my project?
    • How can I compare results with competitors?
    • How are API calls billed?
    • How can I get support?
    • Frequently Asked Questions
    • Troubleshooting
  • Tutorials
    • How to process images from a local directory
    • How to process images from Google Drive
    • How to process images from Google Sheets
    • How to process images from Google Drive using Zapier
    • How to process images from Google Drive using Make.com
    • How to process images from an Excel spreadsheet
    • How to create sticker images
    • How to create a selfie generator
    • How to process images using an iOS or macOS Shortcut
  • Image Editing API (Plus plan)
    • Who is this API for?
    • How do I make my first call?
    • What’s the pricing?
    • Which endpoints are available?
    • Which image sizes and formats are supported?
    • How can I prototype an API call? (API Playground)
    • How long does it take to process an image?
    • How to edit the result of an API call in the Photoroom Web App
    • Background Removal Model Versioning
    • HD Background Removal
    • Pixel Density (DPI)
    • Sandbox Mode
    • Uncertainty score
    • Positioning
    • AI Shadows
    • AI Backgrounds
    • AI Relighting
    • AI Text Removal
    • AI Expand
    • [Alpha] AI Upscale
    • [Alpha] Text-Guided Segmentation
    • What’s the difference with the Image Editing API v1?
    • What’s not possible yet with the Image Editing API v2
    • Image Editing API v1 In-Depth Tutorial [Legacy]
  • Remove Background API (Basic plan)
    • Who is this API for?
    • How do I make my first call?
    • What’s the pricing?
    • Which image sizes and formats are supported?
    • Can I use the URL of an image?
    • How to download the segmentation mask
    • Model Versioning
    • Sandbox Mode
    • Uncertainty score
    • Green screen despill
    • Background Color, Size and Crop
    • Remove.bg compatibility
    • Web Integration
    • Node.js Integration
    • Python Integration
    • iOS / Swift Integration
  • Resources
    • AI Backgrounds Competitors Benchmark (Claid.ai, Phot.ai, Bria.ai)
    • Remove Background Competitors Benchmark (Remove.bg, Clipdrop, SAM, Azure)
    • Grocery Delivery Image API Benchmark (Claid.ai, Picsart)
  • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. Remove Background API (Basic plan)

Sandbox Mode

PreviousModel VersioningNextUncertainty score

Last updated 5 months ago

Was this helpful?

You can make up to 1,000 free calls by month to the Image Editing API using sandbox mode.

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_xxxxxxxxxxxxxxxx)

curl --request POST \
  --url https://sdk.photoroom.com/v1/segment \
  --header 'Accept: image/png, application/json' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: sandbox_xxxxxxxxxxxxxxxx' \
  --form image_file=@/path/to/image.jpg \
  --output result-sandbox-mode.png

(original image)

regular API call

sandbox mode API call