View as Markdown
Claid AI icon

Claid AI ACTION

Remove Background

Easily erases the image's background, effectively isolating the main subject. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Claid AI 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: "claid_ai-remove-background",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    claid_ai: { authProvisionId: "apn_xxxxxxx" },
    image: "File Path or URL",
    category: "Category",
  },
})

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 File Path or URL string
The image to process. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myImage.jpg)
Required
category Category string
Provides a hint about the nature of object in the foreground for a more accurate result of background removal.
Optional
removeBackground Remove Background boolean
Removes image background.
Required
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
claid_ai-remove-background
Version
0.1.3
App
Claid AI
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes