Phantombuster ACTION
Launch Phantom
Adds an agent to the launch queue, See the docs
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Phantombuster account once, then configure and run Launch Phantom 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: "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 -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"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{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",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
agentId Agent ID | string | An ID identifying the agent Required Dynamic |
arguments Arguments | string | Agent arguments. Must be a JSON string, e.g. {"key1": "Value 1", "key2": "Value 2"} Optional |
saveArguments Save Arguments | boolean | If true, argument will be saved as the default launch options for the agent. Optional |
bonusArgument Bonus Argument | string | 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"} Optional |
manualLaunch Manual Launch | boolean | If set, the agent will be considered as launched manually. Optional |
maxInstanceCount Max Instance Count | integer | If set, the agent will only be launched if the number of already running instances is below the specified number. 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
- phantombuster-launch-phantom
- Version
- 0.0.3
- App
- Phantombuster
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗