agents

POST /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.

Request

Base URL
https://api.phantombuster.com/api/v2
Auth
API key in header X-Phantombuster-Key
TypeScript
https://skmtc.dev/phantombuster/apis/phantombuster-api-v2/docs/agents/launch-sync/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-Phantombuster-Orgstring

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

Request body

idstring required

Id of the agent to launch.

saveArgumentboolean

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

saveArgumentsboolean

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

manualLaunchboolean

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

maxInstanceCountnumber

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

includeLogsboolean

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

persistedVolumeKeystring nullable

Key identifying the persisted volume to attach to the launched container.

Response

Agent launched successfully. Response is a stream of NDJSON messages with types - start (sent first, with containerId and agentId), heartbeat (periodic keep-alive), logs (container output), summary (final execution result with containerId, executionTime, and optional exitCode), or error (if something goes wrong).

Changes

No recorded changes to this operation across all 1 revision of this API.