Photoroom API

https://docs.photoroom.com/
Admin
Photoroom API is a powerful image editing platform that uses AI to remove backgrounds, add realistic...
Tokens:124,547
Snippets:1,025
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### API Query Example

Source: https://docs.photoroom.com/remove-background-api-basic-plan/code-samples/python-integration.md

This example shows how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters. This is useful for retrieving specific information or clarification not explicitly present on the page.

```http
GET https://docs.photoroom.com/remove-background-api-basic-plan/code-samples/python-integration.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.photoroom.com/image-editing-api-plus-plan/sandbox-mode.md

This example shows how to perform an HTTP GET request to query the documentation. It includes the 'ask' parameter for a specific question and an optional 'goal' parameter for broader context. The response will contain an answer and relevant sources.

```http
GET https://docs.photoroom.com/image-editing-api-plus-plan/sandbox-mode.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation API

Source: https://docs.photoroom.com/remove-background-api-basic-plan/code-samples/web-integration.md

This example shows how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters.

```http
GET https://docs.photoroom.com/remove-background-api-basic-plan/code-samples/web-integration.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install Dependencies

Source: https://docs.photoroom.com/integrations/how-to-process-images-from-an-excel-spreadsheet.md

Run this command once to install the necessary Python libraries for the script.

```bash
$ pip install requests openpyxl # run once to install the third-party libraries
```

--------------------------------

### Install Requests Library

Source: https://docs.photoroom.com/integrations/how-to-process-images-from-a-local-directory.md

Run this command once to install the 'requests' library, which is required for making API calls.

```bash
pip install requests
```

--------------------------------

### GET Endpoint Example

Source: https://docs.photoroom.com/image-editing-api-plus-plan/quickstart-guide.md

This example demonstrates how to use the GET endpoint to apply edits to an image by providing its URL and configuration through query parameters. The input image must be publicly accessible.

```APIDOC
## GET /v2/edit

### Description
Applies edits to an image specified by a URL using query string arguments.

### Method
GET

### Endpoint
https://image-api.photoroom.com/v2/edit

### Parameters
#### Query Parameters
- **imageUrl** (string) - Required - The URL of the input image.
- **shadow.mode** (string) - Optional - Specifies the shadow mode for editing.
- **background.color** (string) - Optional - Sets the background color.
- **padding** (string) - Optional - Defines the padding around the image.

### Request Example
```sh
curl 'https://image-api.photoroom.com/v2/edit?shadow.mode=ai.soft&background.color=FFFFFF&padding=0.1&imageUrl=URL_OF_YOUR_IMAGE' \
--header 'x-api-key: YOUR_API_KEY' \
--output result-get-endpoint.png
```

### Response
#### Success Response (200)
- The response will be the edited image file.
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.photoroom.com/image-editing-api-plus-plan/ai-uncrop.md

To get more information or clarification not explicitly on the page, use this GET request with the `ask` parameter. The `goal` parameter can be optionally provided to tailor the response.

```http
GET https://docs.photoroom.com/image-editing-api-plus-plan/ai-uncrop.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.photoroom.com/remove-background-api-basic-plan/quickstart-guide.md

To get information not explicitly on the page, make a GET request to the page URL with 'ask' and optional 'goal' query parameters. The response includes answers and relevant documentation excerpts.

```http
GET https://docs.photoroom.com/remove-background-api-basic-plan/quickstart-guide.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.photoroom.com/image-editing-api-plus-plan/subject-outline.md

Use this HTTP GET request to query the documentation dynamically. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter for tailored responses.

```http
GET https://docs.photoroom.com/image-editing-api-plus-plan/subject-outline.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### HTTP GET Request for Dynamic Querying

Source: https://docs.photoroom.com/integrations/how-to-process-images-from-a-local-directory.md

Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.photoroom.com/integrations/how-to-process-images-from-a-local-directory.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.photoroom.com/getting-started/changelog.md

Perform an HTTP GET request on the current page URL with the `ask` query parameter for specific questions and the optional `goal` parameter for broader context. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://docs.photoroom.com/getting-started/changelog.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.photoroom.com/integrations/how-to-process-images-from-google-drive-using-make.com.md

Use this mechanism to dynamically query the documentation. Perform an HTTP GET request on the current page URL with the `ask` query parameter for your question and an optional `goal` parameter for your end goal.

```http
GET https://docs.photoroom.com/integrations/how-to-process-images-from-google-drive-using-make.com.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

Perform an HTTP GET request with 'ask' and optional 'goal' query parameters to retrieve specific information or clarification from the documentation.

```http
GET https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with HTTP GET

Source: https://docs.photoroom.com/video-api-enterprise-plan/overview.md

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. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter.

```http
GET https://docs.photoroom.com/video-api-enterprise-plan/overview.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Call GET Endpoint with Image URL

Source: https://docs.photoroom.com/image-editing-api-plus-plan/quickstart-guide.md

Use this example to make an API call using the GET endpoint. Configure edits via query string arguments and provide the input image URL.

```sh
curl 'https://image-api.photoroom.com/v2/edit?shadow.mode=ai.soft&background.color=FFFFFF&padding=0.1&imageUrl=URL_OF_YOUR_IMAGE' \
--header 'x-api-key: YOUR_API_KEY' \
--output result-get-endpoint.png
```

--------------------------------

### Setup and Iterate Over Apparel Images

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

This snippet sets up the output directory and iterates over apparel image URLs and prompts. It requires the 'os' module for directory creation and assumes APPAREL_IMAGE_URLS, APPAREL_PROMPTS, and APPAREL_OUTPUT_DIRECTORY are defined.

```python
APPAREL_IMAGE_URLS = [
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fapparel%2F1.jpeg?alt=media&token=462bd079-f084-4a97-bdf5-51e1ea6454a3",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fapparel%2F2.jpg?alt=media&token=7666a271-93c8-4fa5-bf46-e550f2832189",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fapparel%2F3.jpg?alt=media&token=3551ca21-e31a-4076-b810-1bc0aacbaceb",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fapparel%2F4.jpg?alt=media&token=4a2d0c5d-b44a-479f-bc35-64fcc3d3d366",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fapparel%2F5.jpeg?alt=media&token=4624dafe-959b-4bfc-b230-7785780abcf7",
    ]

    APPAREL_PROMPTS = [
        "the image displays a jacket hanging on a wall standing against a baby blue background. The background is plain, textureless, doesn't have any discernible objects or patterns, and its color is baby blue",
        "a baseball cap on a baseball field, with a bright sun in the background",
        "a crocheted poncho on a fluffy blanket, with a soft green grass field in the background",
        "the image displays a group of three people standing set against an autumn-themed backdrop, captivating the essence of fall season.",
        "the image illustrates a person walking set against a breathtaking mountain view. It exudes a professionalism in composition and performance.",
    ]

    APPAREL_OUTPUT_DIRECTORY = "./output-bria-ai/apparel/"

    if not os.path.exists(APPAREL_OUTPUT_DIRECTORY):
        os.makedirs(APPAREL_OUTPUT_DIRECTORY)

    iterate_over(image_urls=APPAREL_IMAGE_URLS, prompts=APPAREL_PROMPTS, file_names=list(map(str, range(1, len(APPAREL_IMAGE_URLS) + 1))), result_directory=APPAREL_OUTPUT_DIRECTORY)
```

--------------------------------

### Cosmetic Image Benchmark Setup

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai

Sets up and runs the AI background generation benchmark for cosmetic products. It defines image URLs, prompts, and the output directory, then initiates the image processing.

```python
COSMETIC_IMAGE_URLS = [
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F1.jpeg?alt=media&token=837a3a2c-4621-44bc-84d7-ca1bafd7dad7",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F2.jpeg?alt=media&token=9327b3b6-68a6-4106-88cc-978afa5c048e",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F3.png?alt=media&token=6c25d2aa-4a11-4b00-bac6-b98f59289b5c",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F4.jpg?alt=media&token=be6075e1-b754-4f98-8937-cba8d234942d",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F5.jpg?alt=media&token=982083a1-b8df-40f7-88cc-c9185670f162",
]

COSMETIC_PROMPTS = [
    "the image displays a bottle with a pink substance surrounded by cherry blossom. The image features a minimalistic and professional looking background.",
    "the image displays a tube of false lashes in a bathroom. The image features a minimalistic and professional looking background.",
    "the image displays an orange plastic bottle with a pump top on a tropical beach on a bright day with a slightly blurred background of the ocean",
    "the image displays a tube of lotion on a cream marble countertop. The image features a minimalistic and professional looking background.",
    "the image displays a spray bottle sitting on top 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",
]

COSMETIC_OUTPUT_DIRECTORY = "./output-bria-ai/cosmetic/"

if not os.path.exists(COSMETIC_OUTPUT_DIRECTORY):
    os.makedirs(COSMETIC_OUTPUT_DIRECTORY)

iterate_over(image_urls=COSMETIC_IMAGE_URLS, prompts=COSMETIC_PROMPTS, file_names=list(map(str, range(1, len(COSMETIC_IMAGE_URLS) + 1))), result_directory=COSMETIC_OUTPUT_DIRECTORY)
```

--------------------------------

### Image Editing v2 GET Request Example

Source: https://docs.photoroom.com/getting-started/api-reference-openapi.md

Use this GET endpoint with imageUrl for the simplest integration, especially for no-code tools. No file upload handling is required. The response is the edited image as binary data (image/png by default).

```http
GET https://image-api.photoroom.com/v2/edit?imageUrl=https://example.com/photo.jpg&removeBackground=true&background.color=FFFFFF&outputSize=1000x1000&padding=0.1 HTTP/1.1
Host: image-api.photoroom.com
x-api-key: YOUR_API_KEY
```

--------------------------------

### Setup and Iterate Over Jewelry Images

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

This snippet sets up the output directory and iterates over jewelry image URLs and prompts. It requires the 'os' module for directory creation and assumes JEWELRY_IMAGE_URLS, JEWELRY_PROMPTS, and JEWELRY_OUTPUT_DIRECTORY are defined.

```python
JEWELRY_IMAGE_URLS = [
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F1.jpg?alt=media&token=0afec946-38cf-4773-a96a-d0c158358557",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F2.jpg?alt=media&token=9b93ee57-9343-4611-8156-76c512149002",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F3.jpg?alt=media&token=925a455c-1b58-469d-95c7-7db4ff5ac61e",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F4.jpg?alt=media&token=c694560d-951d-4fe5-8390-a4c5df846f51",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F5.jpg?alt=media&token=38205d4d-ce4f-4168-9a91-94d872aed3fe",
    ]

    JEWELRY_PROMPTS = [
        "the image displays a ring with a pink stone on a cream marble countertop. The image features a minimalistic and professional looking background.",
        "a long necklace on a black velvet cushion, with a cream stone wall in the background",
        "the image displays a pair of earrings on a green marble countertop. The image features a minimalistic and professional looking background.",
        "the image displays a pair of wedding rings sitting next to each other on a concrete countertop. The image features a minimalistic and professional looking background.",
        "the image displays a necklace in a cozy home. The image features a minimalistic and professional looking background.",
    ]

    JEWELRY_OUTPUT_DIRECTORY = "./output-bria-ai/jewelry/"

    if not os.path.exists(JEWELRY_OUTPUT_DIRECTORY):
        os.makedirs(JEWELRY_OUTPUT_DIRECTORY)

    iterate_over(image_urls=JEWELRY_IMAGE_URLS, prompts=JEWELRY_PROMPTS, file_names=list(map(str, range(1, len(JEWELRY_IMAGE_URLS) + 1))), result_directory=JEWELRY_OUTPUT_DIRECTORY)
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.photoroom.com/integrations/how-to-process-images-from-google-sheets.md

To get additional information not directly on the page, perform an HTTP GET request to the page URL with the `ask` query parameter. The optional `goal` parameter can tailor the answer to a broader objective.

```http
GET https://docs.photoroom.com/integrations/how-to-process-images-from-google-sheets.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Setup for phot.ai Jewelry Background Generation

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

Defines image URLs, prompts, and output directory for benchmarking phot.ai's jewelry background generation. Ensures the output directory exists before processing.

```python
JEWELRY_IMAGE_URLS = [
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F1.jpg?alt=media&token=0afec946-38cf-4773-a96a-d0c158358557",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F2.jpg?alt=media&token=9b93ee57-9343-4611-8156-76c512149002",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F3.jpg?alt=media&token=925a455c-1b58-469d-95c7-7db4ff5ac61e",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F4.jpg?alt=media&token=c694560d-951d-4fe5-8390-a4c5df846f51",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F5.jpg?alt=media&token=38205d4d-ce4f-4168-9a91-94d872aed3fe",
    ]

    JEWELRY_PROMPTS = [
        "the image displays a ring with a pink stone on a cream marble countertop. The image features a minimalistic and professional looking background.",
        "a long necklace on a black velvet cushion, with a cream stone wall in the background",
        "the image displays a pair of earrings on a green marble countertop. The image features a minimalistic and professional looking background.",
        "the image displays a pair of wedding rings sitting next to each other on a concrete countertop. The image features a minimalistic and professional looking background.",
        "the image displays a necklace in a cozy home. The image features a minimalistic and professional looking background.",
    ]

    JEWELRY_OUTPUT_DIRECTORY = "./output-phot-ai/jewelry/"

    if not os.path.exists(JEWELRY_OUTPUT_DIRECTORY):
        os.makedirs(JEWELRY_OUTPUT_DIRECTORY)

    iterate_over(image_urls=JEWELRY_IMAGE_URLS, prompts=JEWELRY_PROMPTS, file_names=list(map(str, range(1, len(JEWELRY_IMAGE_URLS) + 1))), result_directory=JEWELRY_OUTPUT_DIRECTORY)
```

--------------------------------

### Query Photoroom Documentation Dynamically

Source: https://docs.photoroom.com/getting-started/troubleshooting.md

Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.photoroom.com/getting-started/troubleshooting.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.photoroom.com/getting-started/api-reference-openapi.md

To get additional information not explicitly present on a page, perform an HTTP GET request to the page URL with the `ask` query parameter for your question and an optional `goal` parameter for the broader objective. The response will include a direct answer and relevant documentation excerpts.

```http
GET https://docs.photoroom.com/getting-started/api-reference-openapi.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Food Image Processing Example

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai

Demonstrates the usage of the image processing functions with a predefined list of food image URLs and corresponding prompts. It sets up the output directory and initiates the processing loop.

```python
if __name__ == "__main__":
    # FOOD

    FOOD_IMAGES_URLS = [
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F1.jpg?alt=media&token=850ab5be-a503-40f1-a270-c7cdcc62bdeb",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F2.png?alt=media&token=9c6e5512-efb8-47bc-b45d-01cb5b00b698",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F3.jpg?alt=media&token=04851dba-83bc-4d24-9549-ad029a838c33",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F4.jpeg?alt=media&token=191746c4-c528-4e2f-9e04-e1cac0b8d4b9",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F5.jpeg?alt=media&token=97421dcf-14b0-4353-913e-03428341e274",
    ]

    FOOD_PROMPTS = [
        "the image displays a plate of vegetables with succulents in the background. The image features a minimalistic and professional looking background.",
        "a chocolate cupcake with blue frosting on a white marbled tray, with a pastel coloured table in the background",
        "a plate of chicken wings and dipping sauces on a black scampered wooden table.",
        "the image displays a piece of bread with avocado and greens on top bathed in a golden light. It has been captured professionally, emphasizing the warm tones and gleaming highlights.",
        "the image displays a bowl with bread and vegetables foregrounded against a breathtaking mountain sunset. The object is set against a picturesque scene of a mountain during sunset.",
    ]

    FOOD_OUTPUT_DIRECTORY = "./output-claid-ai/food/"

    if not os.path.exists(FOOD_OUTPUT_DIRECTORY):
        os.makedirs(FOOD_OUTPUT_DIRECTORY)

    iterate_over(image_urls=FOOD_IMAGES_URLS, prompts=FOOD_PROMPTS, file_names=list(map(str, range(1, len(FOOD_IMAGES_URLS) + 1))), result_directory=FOOD_OUTPUT_DIRECTORY)

    # COSMETIC

```

--------------------------------

### Cosmetic Image Generation Benchmark Setup

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

This section configures the parameters for benchmarking cosmetic product image generation. It specifies the image URLs, associated prompts, and the designated output directory for storing the results.

```python
COSMETIC_IMAGE_URLS = [
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F1.jpeg?alt=media&token=837a3a2c-4621-44bc-84d7-ca1bafd7dad7",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F2.jpeg?alt=media&token=9327b3b6-68a6-4106-88cc-978afa5c048e",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F3.png?alt=media&token=6c25d2aa-4a11-4b00-bac6-b98f59289b5c",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F4.jpg?alt=media&token=be6075e1-b754-4f98-8937-cba8d234942d",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fcosmetic%2F5.jpg?alt=media&token=982083a1-b8df-40f7-88cc-c9185670f162",
]

COSMETIC_PROMPTS = [
    "the image displays a bottle with a pink substance surrounded by cherry blossom. The image features a minimalistic and professional looking background.",
    "the image displays a tube of false lashes in a bathroom. The image features a minimalistic and professional looking background.",
    "the image displays an orange plastic bottle with a pump top on a tropical beach on a bright day with a slightly blurred background of the ocean",
    "the image displays a tube of lotion on a cream marble countertop. The image features a minimalistic and professional looking background.",
    "the image displays a spray bottle sitting on top 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",
]

COSMETIC_OUTPUT_DIRECTORY = "./output-bria-ai/cosmetic/"

if not os.path.exists(COSMETIC_OUTPUT_DIRECTORY):
    os.makedirs(COSMETIC_OUTPUT_DIRECTORY)
```

--------------------------------

### API Usage Response Example

Source: https://docs.photoroom.com/getting-started/pricing.md

An example of the JSON response received when checking your API account usage. It shows the number of available images and the total subscription limit.

```json
{
  "images": {
    "available": 83,
    "subscription": 100
  },
  "plan": "basic"
}
```

--------------------------------

### Food Image Generation Benchmark Setup

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

This section sets up the parameters for benchmarking food image generation. It defines the image URLs, corresponding prompts, and the output directory for saving the generated images.

```python
FOOD_IMAGES_URLS = [
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F1.jpg?alt=media&token=850ab5be-a503-40f1-a270-c7cdcc62bdeb",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F2.png?alt=media&token=9c6e5512-efb8-47bc-b45d-01cb5b00b698",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F3.jpg?alt=media&token=04851dba-83bc-4d24-9549-ad029a838c33",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F4.jpeg?alt=media&token=191746c4-c528-4e2f-9e04-e1cac0b8d4b9",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Ffood%2F5.jpeg?alt=media&token=97421dcf-14b0-4353-913e-03428341e274",
]

FOOD_PROMPTS = [
    "the image displays a plate of vegetables with succulents in the background. The image features a minimalistic and professional looking background.",
    "a chocolate cupcake with blue frosting on a white marbled tray, with a pastel coloured table in the background",
    "a plate of chicken wings and dipping sauces on a black scampered wooden table.",
    "the image displays a piece of bread with avocado and greens on top bathed in a golden light. It has been captured professionally, emphasizing the warm tones and gleaming highlights.",
    "the image displays a bowl with bread and vegetables foregrounded against a breathtaking mountain sunset. The object is set against a picturesque scene of a mountain during sunset.",
]

FOOD_OUTPUT_DIRECTORY = "./output-bria-ai/food/"

if not os.path.exists(FOOD_OUTPUT_DIRECTORY):
    os.makedirs(FOOD_OUTPUT_DIRECTORY)

iterate_over(image_urls=FOOD_IMAGES_URLS, prompts=FOOD_PROMPTS, file_names=list(map(str, range(1, len(FOOD_IMAGES_URLS) + 1))), result_directory=FOOD_OUTPUT_DIRECTORY)
```

--------------------------------

### Curl Example for Checking API Usage

Source: https://docs.photoroom.com/getting-started/pricing.md

An example using curl to call the API endpoint for checking account usage. Remember to replace 'YOUR_API_KEY' with your actual API key.

```shell
curl --location 'https://image-api.photoroom.com/v2/account' \
  --header 'x-api-key: YOUR_API_KEY'
```

--------------------------------

### Setup Jewelry Background Generation

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

Configures image URLs, prompts, and output directory for generating backgrounds for jewelry images. Ensures the output directory exists before proceeding.

```python
JEWELRY_IMAGE_URLS = [
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F1.jpg?alt=media&token=0afec946-38cf-4773-a96a-d0c158358557",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F2.jpg?alt=media&token=9b93ee57-9343-4611-8156-76c512149002",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F3.jpg?alt=media&token=925a455c-1b58-469d-95c7-7db4ff5ac61e",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F4.jpg?alt=media&token=c694560d-951d-4fe5-8390-a4c5df846f51",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fjewelry%2F5.jpg?alt=media&token=38205d4d-ce4f-4168-9a91-94d872aed3fe",
]

JEWELRY_PROMPTS = [
    "the image displays a ring with a pink stone on a cream marble countertop. The image features a minimalistic and professional looking background.",
    "a long necklace on a black velvet cushion, with a cream stone wall in the background",
    "the image displays a pair of earrings on a green marble countertop. The image features a minimalistic and professional looking background.",
    "the image displays a pair of wedding rings sitting next to each other on a concrete countertop. The image features a minimalistic and professional looking background.",
    "the image displays a necklace in a cozy home. The image features a minimalistic and professional looking background.",
]

JEWELRY_OUTPUT_DIRECTORY = "./output-claid-ai/jewelry/"

if not os.path.exists(JEWELRY_OUTPUT_DIRECTORY):
    os.makedirs(JEWELRY_OUTPUT_DIRECTORY)

iterate_over(image_urls=JEWELRY_IMAGE_URLS, prompts=JEWELRY_PROMPTS, file_names=list(map(str, range(1, len(JEWELRY_IMAGE_URLS) + 1))), result_directory=JEWELRY_OUTPUT_DIRECTORY)
```

--------------------------------

### Setup for phot.ai People Background Generation

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

Defines image URLs, prompts, and output directory for benchmarking phot.ai's people background generation. Ensures the output directory exists before processing.

```python
PEOPLE_IMAGE_URLS = [
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F1.jpg?alt=media&token=5b57a70d-e94d-4056-8e48-2b8a2c296028",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F2.jpg?alt=media&token=f0e8a0bb-9fd7-4cc3-bd90-b5655321d46d",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F3.jpg?alt=media&token=37ade83a-611e-4346-b4fe-5ee484f69ea3",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F4.jpg?alt=media&token=3569a732-9be2-4b2d-b685-c55a1093fca8",
        "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F5.jpg?alt=media&token=38875d9b-8f48-4bec-a30a-ca10be2b86d5",
    ]

    PEOPLE_PROMPTS = [
        "a person standing with their eyes closed on an old, twisted brick wall, with a grey field in the background",
        "the image features a person walking on a boulder with a breathtaking mountain view in the background.",
        "the image displays a person wearing glasses and a green shirt with New York in the background. The overall scenery in the background is typical and instantly transports you to New York",
        "the image displays a person riding a skateboard set against an autumn-themed backdrop, captivating the essence of fall season.",
        "the image displays a person holding a suit case on a tropical beach on a bright day with a slightly blurred background of the ocean",
    ]

    PEOPLE_OUTPUT_DIRECTORY = "./output-phot-ai/people/"

    if not os.path.exists(PEOPLE_OUTPUT_DIRECTORY):
        os.makedirs(PEOPLE_OUTPUT_DIRECTORY)

    iterate_over(image_urls=PEOPLE_IMAGE_URLS, prompts=PEOPLE_PROMPTS, file_names=list(map(str, range(1, len(PEOPLE_IMAGE_URLS) + 1))), result_directory=PEOPLE_OUTPUT_DIRECTORY)
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.photoroom.com/image-editing-api-plus-plan/ai-ironing.md

To get more information not directly on the page, perform an HTTP GET request to the page URL with the `ask` query parameter. An optional `goal` parameter can be added to tailor the response.

```http
GET https://docs.photoroom.com/image-editing-api-plus-plan/ai-ironing.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with Ask and Goal Parameters

Source: https://docs.photoroom.com/image-editing-api-plus-plan/alpha-ai-upscale

Use this GET request to query the documentation index. The 'ask' parameter takes a specific question, and the optional 'goal' parameter helps tailor the answer to a broader objective.

```http
GET https://docs.photoroom.com/image-editing-api-plus-plan/preview-ai-upscale.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Query Documentation with Ask Parameter

Source: https://docs.photoroom.com/remove-background-api-basic-plan/uncertainty-score.md

To get information not explicitly on the page, make an HTTP GET request to the page URL with the 'ask' query parameter. An optional 'goal' parameter can be included to tailor the response.

```http
GET https://docs.photoroom.com/remove-background-api-basic-plan/uncertainty-score.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Generate AI Background with Image Guidance

Source: https://docs.photoroom.com/image-editing-api-plus-plan/ai-backgrounds.md

This example demonstrates how to generate an AI background using an original image and a guidance image. It utilizes the `background.guidance.imageFile` parameter to specify the guidance image.

```APIDOC
## POST /v2/edit

### Description
Generates an AI background using an original image and a guidance image.

### Method
POST

### Endpoint
https://image-api.photoroom.com/v2/edit

### Parameters
#### Request Body
- **imageFile** (file) - Required - The original image file.
- **referenceBox** (string) - Required - Specifies the reference box, e.g., "originalImage".
- **background.guidance.imageFile** (file) - Required - The guidance image file.

### Request Example
```bash
curl --request POST \
  --url https://image-api.photoroom.com/v2/edit \
  --header 'x-api-key: YOUR_API_KEY' \
  --form 'imageFile=@"/path/to/original-image.jpeg"' \
  --form 'referenceBox="originalImage"' \
  --form 'background.guidance.imageFile=@"/path/to/guidance-image.jpeg"' \
  --output result-ai-background-with-guidance.png
```

### Response
#### Success Response (200)
- **output** (file) - The generated AI background image.
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.photoroom.com/image-editing-api-plus-plan/flat-lay.md

Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.photoroom.com/image-editing-api-plus-plan/flat-lay.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Setup People Background Generation

Source: https://docs.photoroom.com/resources/ai-backgrounds-competitors-benchmark-claid.ai-phot.ai-bria.ai.md

Configures image URLs, prompts, and output directory for generating backgrounds for people images. Ensures the output directory exists before proceeding.

```python
# PEOPLE

PEOPLE_IMAGE_URLS = [
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F1.jpg?alt=media&token=5b57a70d-e94d-4056-8e48-2b8a2c296028",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F2.jpg?alt=media&token=f0e8a0bb-9fd7-4cc3-bd90-b5655321d46d",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F3.jpg?alt=media&token=37ade83a-611e-4346-b4fe-5ee484f69ea3",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F4.jpg?alt=media&token=3569a732-9be2-4b2d-b685-c55a1093fca8",
    "https://firebasestorage.googleapis.com/v0/b/photoroom-demos.appspot.com/o/api-benchmark%2Fai-backgrounds%2Fpeople%2F5.jpg?alt=media&token=38875d9b-8f48-4bec-a30a-ca10be2b86d5",
]

PEOPLE_PROMPTS = [
    "a person standing with their eyes closed on an old, twisted brick wall, with a grey field in the background",
    "the image features a person walking on a boulder with a breathtaking mountain view in the background.",
    "the image displays a person wearing glasses and a green shirt with New York in the background. The overall scenery in the background is typical and instantly transports you to New York",
    "the image displays a person riding a skateboard set against an autumn-themed backdrop, captivating the essence of fall season.",
    "the image displays a person holding a suit case on a tropical beach on a bright day with a slightly blurred background of the ocean",
]

PEOPLE_OUTPUT_DIRECTORY = "./output-claid-ai/people/"

if not os.path.exists(PEOPLE_OUTPUT_DIRECTORY):
    os.makedirs(PEOPLE_OUTPUT_DIRECTORY)

iterate_over(image_urls=PEOPLE_IMAGE_URLS, prompts=PEOPLE_PROMPTS, file_names=list(map(str, range(1, len(PEOPLE_IMAGE_URLS) + 1))), result_directory=PEOPLE_OUTPUT_DIRECTORY)
```
Tokens:
Raw