Skip to main content
PhotoRoom logo
  • Category: images & design
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 4
  • Triggers: 0
  • Slug: PHOTOROOM
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: PHOTOROOM_EDIT_IMAGEApply combined PhotoRoom v2 edits to an image URL or uploaded file. Sandbox output is free and watermarked, while live calls are charged; Composio-managed credentials support live calls only and cannot use templates.Instant: Supported on the latest version.Instant pricing: $0.10 per successful image edit

Input Parameters

string
Uniform outer margin: a ratio from 0 to 0.49, a percentage from 0% to 49% such as 30%, or a pixel value such as 100px.
string
Uniform padding around the subject: a ratio from 0 to 0.49, a percentage from 0% to 49% such as 30%, or a pixel value such as 100px.
string
Publicly reachable direct image URL. Provide exactly one of image_url or image_file.
number
Optional output pixel density from 72 to 1200 DPI.
object
Image file to upload. Provide exactly one of image_file or image_url.
string
Describe an AI edit to apply through PhotoRoom’s editWithAI operation.
string ("sandbox" | "live")
required
Choose live for charged non-watermarked output, or sandbox for free watermarked output.
string
Output size: WIDTHxHEIGHT such as 128x128, auto, originalImage, or croppedSubject.
string ("ai.soft" | "ai.hard" | "ai.floating" | "ai.preset-soft" | "ai.preset-hard" | "ai.auto-with-overrides")
Shadow generation mode to apply; omit to leave shadows unchanged.
string
PhotoRoom template UUID to apply as part of the v2 edit.
string ("ai.fast" | "ai.slow")
Use ai.fast for speed or ai.slow for higher quality; omit to skip upscaling.
string ("png" | "jpeg" | "jpg" | "webp" | "avif")
Output image format.
string
Replace the background with a color name such as red or blue, or a hex value without # such as FF0000 or FF0000EE. Pass remove_background explicitly as false to instead only fill padding and transparent areas with this color.
string
Generate a replacement background from this text prompt.
boolean
Remove the source image background as part of this edit. Setting any background replacement field implies this, since PhotoRoom only replaces a background it has removed.
string ("ai.artificial" | "ai.natural" | "ai.all")
Remove artificial text, natural text, or all text; omit to keep detected text.
string
Replace the background with an image from this public URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHOTOROOM_GENERATE_IMAGEGenerate an image from a text prompt with PhotoRoom v2. Sandbox output is free and watermarked, while live calls are charged; Composio-managed credentials support live calls only.Instant: Supported on the latest version.Instant pricing: $0.10 per successful generated image

Input Parameters

integer
Optional generation seed for reproducible output when supported.
string ("LANDSCAPE_16_9" | "LANDSCAPE_4_3" | "PORTRAIT_16_9" | "PORTRAIT_4_3" | "SQUARE_HD")
Requested generated-image size.
string
required
Text description of the image to generate.
string ("sandbox" | "live")
required
Choose live for charged non-watermarked output, or sandbox for free watermarked output.
string ("png" | "jpeg" | "jpg" | "webp" | "avif")
Output image format.
boolean
Remove the generated image background. Defaults to false so the scene described by the prompt is retained.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHOTOROOM_GET_ACCOUNT_USAGEReturn the connected live PhotoRoom account’s reported plan and remaining image credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PHOTOROOM_REMOVE_BACKGROUNDRemove the background from one uploaded image using PhotoRoom’s Basic API. Sandbox output is free and watermarked, while live calls are charged; Composio-managed credentials support live calls only.Instant: Supported on the latest version.Instant pricing: $0.02 per successful background removal

Input Parameters

boolean
Crop the result around the detected foreground subject.
string ("preview" | "medium" | "hd" | "full")
Output resolution tier.
string ("png" | "jpg" | "webp")
Output image format.
boolean
Reduce background color spill around foreground edges.
string ("rgba" | "alpha")
Return the color image with transparency (rgba) or only the alpha mask (alpha).
object
required
Image file whose background will be removed.
string ("sandbox" | "live")
required
Choose live for charged non-watermarked output, or sandbox for free watermarked output.
string
Optional output background color accepted by PhotoRoom instead of transparency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not