PhotoRoom

Remove backgrounds from images automatically with PhotoRoom.

AI and MLAPI key1 actionAll integrations

On this page

Connect
Call it from a workflow
Actions (1)
removeBackground
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("photoroom", "removeBackground", {
    "file": "<image file>",
    "filename": "<generated filename>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("PhotoRoom answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "photoroom-removebackground",
  name: "PhotoRoom: Remove background",
  description: "Calls PhotoRoom when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("photoroom", {
      "action": "removeBackground",
      "file": "<image file>",
      "filename": "<generated filename>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/photoroom/removeBackground" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"file":"<image file>","filename":"<generated filename>"}}'

Actions

removeBackgroundin catalog

Remove background. Remove the background of the image given as input

Also accepted as remove_background.

Input	Type	Description
`file`required	file	Image file
`filename`required	text	Generated filename

Details

Id: photoroom
Category: AI and ML
Tags: image, background-removal, editing, ai
Package: @activepieces/piece-photoroom@0.1.3
Tier: Community