View as Markdown
api4ai icon

api4ai ACTION

Background Removal

Automatically and quickly remove image background with high accuracy. Powered by API4AI.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's api4ai account once, then configure and run Background Removal from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "api4ai-background-removal",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    api4ai: { authProvisionId: "apn_xxxxxxx" },
    image: "Image",
    mask: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Background Removal inputs
Property Type Description
image Image string
Input image. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).
Required
mask Mask mode boolean
Return the foreground object mask instead of the image with the background removed.
Optional
representation Result image representation string

Return the result image as:

  • path to a file (default)
  • URL to a file hosted by api4ai (valid for 1 day)
  • Base64 string with file's content
  • Buffer encoded in JSON with a file's content
  • Array of bytes with a file's content
Optional
syncDir SyncDir dir
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
api4ai-background-removal
Version
0.0.6
App
api4ai
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes