/agents/launch

post

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

Adds an agent to the launch queue.

Body Params

string

required

Id of the agent to launch.

argument

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

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

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.

internalMetadata

object | null

PhantomBuster-managed key-value pairs for internal container tagging.

userCustomMetadata

object | null

User-defined key-value pairs for container tagging.

Headers

X-Phantombuster-Org

string

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

Responses

200

Agent launched successfully.

400

A provided parameter is duplicated or the launch argument is too big.