PhantomBuster for AI agents
Agents read PhantomBuster at once. Changes and sends are held for a person's approval by default.
About PhantomBuster
PhantomBuster is a cloud-based data extraction and automation platform that enables users to automate actions on the web, such as scraping data, generating leads, and automating social media tasks.
What an agent can do in PhantomBuster
Every PhantomBuster action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in PhantomBuster without asking first. 24 actions.
- Get AgentTool to get an agent by its ID. Use when you need to retrieve detailed information about a specific Phantombuster agent, including its configuration, schedule, and execution settings.
- Get Agent Containers (v1)Tool to get a list of ended containers for an agent, ordered by date. Use when you need to retrieve the last available output logs from an agent. This is a legacy v1 API endpoint.
- Get Agent Output (v1)Tool to get incremental data from an agent including console output, status, progress and messages. This is a legacy v1 API endpoint designed for easy incremental data retrieval. Use outputPos to trac
- Get All AgentsTool to fetch all agents associated with the current user or organization. Use after validating your Phantombuster API key to list available agents.
- Get Deleted AgentsTool to get deleted agents for the current user or organization. Use when you need to audit recently removed agents.
- Get Branches DiffTool to get the length difference between the staging and release branch of all scripts. Use when assessing branch changes before deployment.
- Get All BranchesTool to fetch all branches associated with the current organization. Use when you need to enumerate every branch across your scripts.
- Get Containers Fetch AllTool to get all containers associated with a specified agent. Use when you need to retrieve every container for a given agent, for monitoring or reporting.
- Get Leads By ListTool to fetch leads by their list ID. Use when you need to retrieve leads from a specific list with optional pagination and filtering.
- Get IP LocationTool to retrieve the country of a given or environment IP address. Use when you need to geolocate an IP endpoint. Example: get_location_ip(ip="8.8.8.8")
- Export Agent Usage CSVTool to export agent usage CSV for current organization. Use when you need a downloadable report of all agents' run statistics in CSV format.
- Export Container Usage CSVTool to export container usage CSV for current organization. Use when you need a downloadable CSV report of container execution history up to 6 months; URL expires in 30 days.
Show all 24
- Get OrganizationTool to fetch current organization details. Use when you need to retrieve the organization associated with the provided API key.
- Get Agent GroupsTool to get agent groups and order for the current organization. Use when you need to review how agents are grouped and ordered.
- Get Organization ResourcesTool to get current organization's resources and usage. Use when you need to monitor quotas.
- Get Org Running ContainersTool to get the current organization's running containers. Use after listing agents to identify active containers across the organization.
- Get Org Storage Lists Fetch AllTool to fetch all storage lists for the authenticated organization. Use when you need to enumerate every storage list available (Beta).
- Get ScriptTool to fetch a script by its unique ID. Use when you need to retrieve detailed metadata about a specific script, including its branches, visibility, and optionally its source code.
- Get Script CodeTool to get the code of a script. Use when you need to retrieve the source code content of a specific script.
- Get All ScriptsTool to fetch all scripts for the current user. Use after authenticating your Phantombuster API key to list scripts without their code bodies.
- Get User InformationTool to get information about your PhantomBuster account and your agents using the legacy v1 API. Use when you need to check account quotas, remaining resources, or list associated agents.
- Search Company ObjectsTool to search company objects in Phantombuster's organizational storage. Use when you need to find companies by specific criteria or perform a global search.
- Search Lead ObjectsTool to search lead objects in Phantombuster org storage. Use when you need to find leads based on search criteria or filter conditions.
- Get Script by NameTool to retrieve a script by its name from Phantombuster (Legacy v1 API). Use when you need to fetch script metadata or content by name. Supports both JSON (structured) and raw (plain text) response f
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 29 actions.
- Abort Agent (v1)Tool to abort all running instances of an agent using the legacy v1 API. Use when you need to immediately stop an agent's execution. Supports soft abort for graceful shutdown.
- Delete AgentTool to delete an agent by id. Use when you need to remove a PhantomBuster agent. Ensure the agent is not currently running before deletion.
- Delete Lead ObjectsTool to delete one or more lead objects from organization storage. Use when you need to remove lead data. Provide either leadObjectId, or both slug and type parameters.
- Delete Many LeadsTool to delete multiple leads from organization storage. Use when you need to bulk delete leads by their IDs.
- Delete ListTool to delete a storage list by id (Beta). Use when you need to remove a list from organization storage.
- Delete ScriptTool to delete a script by id. Use when you need to remove a specific script from PhantomBuster. Optionally specify a branch and environment to delete a specific version.
- Unschedule All Agent LaunchesTool to unschedule all scheduled launches for agents. Use when you need to disable every automated agent run organization-wide after verifying your API key.
- Request AI CompletionTool to request a text completion from the AI module. Use when you need to generate text based on a prompt.
- Create BranchTool to create a new branch. Use when you need to isolate updates by creating a separate branch. Use after authenticating with your Phantombuster API key and optionally specifying an organization.
- Delete BranchTool to delete a branch by id. Use when you need to remove obsolete or incorrect script branches; ensure the branch exists before calling.
- Solve hCaptchaTool to solve an hCaptcha challenge. Use when you need a valid hCaptcha token for form submissions or automation flows.
- Generate Identity TokenTool to generate an identity token for PhantomBuster. Use when you need to create a new identity token for authentication or session management.
Show all 29
- Save Many LeadsTool to save multiple leads (1-20) to organization storage in a single batch operation (Beta). Use when you need to create or update leads with LinkedIn profile data and optional enrichment fields.
- Solve reCAPTCHATool to solve a reCAPTCHA challenge (v2 or v3). Use when you need a valid reCAPTCHA response token for form submissions or automation. Note: API returns 200 status even on errors; check the error fiel
- Update Script VisibilityTool to update the visibility of a script. Use when you need to change whether a script is private, public, or open source.
- Release BranchTool to release a script branch. Use when you need to deploy a branch to production or release changes to specified scripts.
- Save AgentTool to create a new agent or update an existing one. Use when you need to configure an agent's launch schedule, settings, or behavior. If an agent ID is provided, the existing agent will be updated;
- Save Agent GroupsTool to update agent groups and order for the current user's organization. Use when you need to reorganize agents into groups or change their display order.
- Save Company ObjectTool to save one company object to the organization storage. Use when you need to create or update a company object with LinkedIn company data and custom properties.
- Save Many Company ObjectsTool to save many company objects to organization storage. Use when you need to bulk insert or update company data with a minimum of 1 and maximum of 20 objects per request.
- Save Identity EventTool to save an identity event to Phantombuster. Use when you need to record user interactions or activities associated with specific social media profiles.
- Save Lead ObjectTool to save a lead object to organization storage. Use when you need to store or update lead information with custom properties.
- Save ListTool to save (create or update) a list with filter criteria. Use when you need to create a new list or update an existing one by providing a filter configuration. This is a Beta feature.
- Save ScriptTool to create a new script or update an existing one. Provide an id to update; otherwise creates new script. Use when you need to save JavaScript automation code to Phantombuster.
- Stop AgentTool to stop a running agent. Use when you need to halt agent execution, optionally cascading to slave agents or switching to manual launch mode.
- Update Script (v1 API)Tool to update an existing script or create a new one if it does not exist (Legacy v1 API). Use when you need to save script code to Phantombuster. If insertOnly is true, the operation will fail if a
- Update Script Access ListTool to update the access list of a script. Use when you need to add or remove users/orgs from a script's access list in a specific branch.
- Save LeadTool to save or update a lead in Phantombuster org storage. Use when you need to store LinkedIn profile data or other lead information.
- Save Many Lead ObjectsTool to save multiple lead objects to Phantombuster's organization storage. Use when you need to create or update multiple lead objects in a single API call.
Changes wait in Needs you
Changes and sends in PhantomBuster are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
PhantomBuster questions
Can an agent change data in PhantomBuster on its own?
Not by default. Changes and sends in PhantomBuster are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in PhantomBuster?
This connector lists 24 read actions. Reads run at once, without waiting for approval.
How does PhantomBuster connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.