# Launch Phantom — Phantombuster

> Adds an agent to the launch queue, See the docs

- Key: `phantombuster-launch-phantom`
- Type: Action (Write)
- Version: 0.0.3
- App: Phantombuster (`phantombuster`) — https://pipedream.com/apps/phantombuster.md
- This page (HTML): https://pipedream.com/apps/phantombuster/actions/launch-phantom
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/phantombuster/actions/launch-phantom/launch-phantom.mjs

## Description

Adds an agent to the launch queue, [See the docs](https://hub.phantombuster.com/reference/post_agents-launch-1)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `agentId` | `string` | Yes | An ID identifying the agent Options are loaded from the connected account. |
| `arguments` | `string` | No | Agent arguments. Must be a JSON string, e.g. {"key1": "Value 1", "key2": "Value 2"} |
| `saveArguments` | `boolean` | No | If true, argument will be saved as the default launch options for the agent. |
| `bonusArgument` | `string` | No | Agent bonus argument. This bonus argument is single-use, it will only be used for the current launch. Must be a JSON string, e.g. {"key1": "Value 1", "key2": "Value 2"} |
| `manualLaunch` | `boolean` | No | If set, the agent will be considered as launched manually. |
| `maxInstanceCount` | `integer` | No | If set, the agent will only be launched if the number of already running instances is below the specified number. |

## 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": "phantombuster",
      },
    },
  },
)

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: "phantombuster-launch-phantom",
  arguments: {
    agentId: "Agent ID",
    arguments: "Arguments",
  },
})
```

**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: "phantombuster-launch-phantom",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    phantombuster: { authProvisionId: "apn_xxxxxxx" },
    agentId: "Agent ID",
    arguments: "Arguments",
  },
})

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": "phantombuster-launch-phantom",
    "configured_props": {
      "phantombuster": { "authProvisionId": "apn_xxxxxxx" },
      "agentId": "Agent ID",
      "arguments": "Arguments"
    }
  }'
```

---

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