/agents/launch-sync

post

https://api.phantombuster.com/api/v2/agents/launch-sync

Launches an agent and streams execution status in real-time using NDJSON format. The stream begins with a start message exposing the containerId (so clients can reconnect via /containers/attach on disconnect) and then includes heartbeat messages, execution summary, and error messages if any occur. Optionally includes log lines when the includeLogs body parameter is set to true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Id of the agent to launch.

argument

string | object

Agent argument. Can either be a JSON string or a plain object. The argument can be retrieved with buster.argument in the agent's script.

arguments

string | object

Agent argument. Can either be a JSON string or a plain object. The argument can be retrieved with buster.argument in the agent's script.

bonusArgument

string | object

Agent bonus argument. Can either be a JSON string or a plain object. This bonus argument is single-use, it will only be used for the current launch. If present, it will be merged with the original argument, resulting in an effective argument that can be retrieved with buster.argument in the agent's script.

saveArgument

boolean

If true, argument will be saved as the default launch options for the agent.

saveArguments

boolean

If true, argument will be saved as the default launch options for the agent.

manualLaunch

boolean

If set, the agent will be considered as "launched manually".

maxInstanceCount

number

≥ 1

If set, the agent will only be launched if the number of already running instances is below the specified number.

includeLogs

boolean

If true, agent logs will be included in the stream. Defaults to false.

Headers

X-Phantombuster-Org

string

ID of the org that is perfoming the operation (not necessary when using a third party key)

Responses

400

A provided parameter is duplicated or the launch argument is too big, or agent not found.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/x-ndjson