PhantomBuster

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.

Tool to delete an agent by id. Use when you need to remove a PhantomBuster agent. Ensure the agent is not currently running before deletion.

Tool 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.

Tool to delete multiple leads from organization storage. Use when you need to bulk delete leads by their IDs.

Tool to delete a storage list by id (Beta). Use when you need to remove a list from organization storage.

Tool 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.

Tool 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.

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.

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 track position.

Tool to fetch all agents associated with the current user or organization. Use after validating your Phantombuster API key to list available agents.

Tool to get deleted agents for the current user or organization. Use when you need to audit recently removed agents.

Tool to get the length difference between the staging and release branch of all scripts. Use when assessing branch changes before deployment.

Tool to fetch all branches associated with the current organization. Use when you need to enumerate every branch across your scripts.

Tool 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.

Tool to fetch leads by their list ID. Use when you need to retrieve leads from a specific list with optional pagination and filtering.

Tool 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")

Tool to export agent usage CSV for current organization. Use when you need a downloadable report of all agents' run statistics in CSV format.

Tool 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.

Tool to fetch current organization details. Use when you need to retrieve the organization associated with the provided API key.

Tool to get agent groups and order for the current organization. Use when you need to review how agents are grouped and ordered.

Tool to get current organization's resources and usage. Use when you need to monitor quotas.

Tool to get the current organization's running containers. Use after listing agents to identify active containers across the organization.

Tool to fetch all storage lists for the authenticated organization. Use when you need to enumerate every storage list available (Beta).

Tool 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.

Tool 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 formats.

Tool to get the code of a script. Use when you need to retrieve the source code content of a specific script.

Tool to fetch all scripts for the current user. Use after authenticating your Phantombuster API key to list scripts without their code bodies.

Tool 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.

Tool to unschedule all scheduled launches for agents. Use when you need to disable every automated agent run organization-wide after verifying your API key.

Tool to request a text completion from the AI module. Use when you need to generate text based on a prompt.

Tool 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.

Tool to delete a branch by id. Use when you need to remove obsolete or incorrect script branches; ensure the branch exists before calling.

Tool to solve an hCaptcha challenge. Use when you need a valid hCaptcha token for form submissions or automation flows.

Tool to generate an identity token for PhantomBuster. Use when you need to create a new identity token for authentication or session management.

Tool 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.

Tool 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 field in the response.

Tool to update the visibility of a script. Use when you need to change whether a script is private, public, or open source.

Tool to release a script branch. Use when you need to deploy a branch to production or release changes to specified scripts.

Tool 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; otherwise, a new agent is created.

Tool 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.

Tool 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.

Tool 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.

Tool to save an identity event to Phantombuster. Use when you need to record user interactions or activities associated with specific social media profiles.

Tool to save or update a lead in Phantombuster org storage. Use when you need to store LinkedIn profile data or other lead information.

Tool to save a lead object to organization storage. Use when you need to store or update lead information with custom properties.

Tool 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.

Tool 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.

Tool 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.

Tool to search company objects in Phantombuster's organizational storage. Use when you need to find companies by specific criteria or perform a global search.

Tool to search lead objects in Phantombuster org storage. Use when you need to find leads based on search criteria or filter conditions.

Tool to stop a running agent. Use when you need to halt agent execution, optionally cascading to slave agents or switching to manual launch mode.

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 script with the same name already exists.

Tool 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.