View as Markdown
DeepImage icon

DeepImage ACTION

Remove Background

Removes the background from the provided image using DeepImage. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's DeepImage account once, then configure and run Remove Background 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: "deepimage-remove-background",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    deepimage: { authProvisionId: "apn_xxxxxxx" },
    image: "Image Path or URL",
    backgroundColor: "Background Color",
  },
})

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.

Remove Background inputs
Property Type Description
image Image Path or URL string
Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/example.jpg).
Required
backgroundColor Background Color string
The background color for the image.
Required
cropType Crop Type string
The crop type for background removal.
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
deepimage-remove-background
Version
0.1.2
App
DeepImage
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes