Launch Agent
phantombuster.launch_agent
ActionBusiness appsconnection required
Calls the Phantombuster API with the connection's credentials.
Queue one run of a Phantom and return the run's container id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Phantombuster
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- org_id, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
agent_id The Phantom's numeric id, which its URL in the Phantombuster dashboard ends with. | string | Yes | — | — | 1234567890123456 |
argument The launch options the Phantom's script reads as buster.argument, such as the profile URLs to process. | object | No | — | — | {"numberOfProfiles":10} |
bonus_argument Extra options merged into the argument for this one run only, and not kept as the Phantom's defaults. | object | No | — | — | {"sessionCookie":"from-an-earlier-step"} |
save_argument Save the argument given here as the Phantom's default launch options. | boolean | No | false | — | — |
manual_launch Record this run as a manual launch rather than an automated one. | boolean | No | false | — | — |
max_instance_count Launch only if fewer than this many instances of the Phantom are already running, so a slow run is not piled on top of. | number | No | — | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"agent_id": "1234567890123456",
"argument": {
"numberOfProfiles": 10
},
"bonus_argument": {
"sessionCookie": "from-an-earlier-step"
},
"manual_launch": false,
"save_argument": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
agent_id The Phantom that was launched. | string | — |
container_id The queued run's id, which the container nodes below take. | string | — |
launched True once Phantombuster accepted the launch. | boolean | — |
response Phantombuster's own response body for this call, passed through unchanged. | object | — |
{
"agent_id": "",
"container_id": "",
"launched": false,
"response": {}
}Notes
- Launching is asynchronous: this returns a container id for the queued run, not the run's results. Read them back in a later step with Get Container, Get Container Result or Get Agent Output — after a delay, on a schedule, or in a polling loop.
- The org this acts for comes from the connection's optional org_id, sent as the X-Phantombuster-Org header; leave it unset when the key already names one org.
Related Phantombuster nodes
See Launch Agent run in a workflow.
In a technical demo we add the Phantombuster connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.