# Remove Background — DeepImage

> Removes the background from the provided image using DeepImage. See the documentation

- Key: `deepimage-remove-background`
- Type: Action (Write)
- Version: 0.1.2
- App: DeepImage (`deepimage`) — https://pipedream.com/apps/deepimage.md
- This page (HTML): https://pipedream.com/apps/deepimage/actions/remove-background
- Hints: destructive · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/deepimage/actions/remove-background/remove-background.mjs

## Description

Removes the background from the provided image using DeepImage. [See the documentation](https://documentation.deep-image.ai/image-processing/background-processing)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `image` | `string` | Yes | Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/example.jpg). |
| `backgroundColor` | `string` | Yes | The background color for the image. |
| `cropType` | `string` | No | The crop type for background removal. |
| `syncDir` | `dir` | No | SyncDir |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "deepimage",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "deepimage-remove-background",
  arguments: {
    image: "Image Path or URL",
    backgroundColor: "Background Color",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "deepimage-remove-background",
    "configured_props": {
      "deepimage": { "authProvisionId": "apn_xxxxxxx" },
      "image": "Image Path or URL",
      "backgroundColor": "Background Color"
    }
  }'
```

---

- App: https://pipedream.com/apps/deepimage.md · All apps: https://pipedream.com/apps