Phantombuster

Learn how to use Phantombuster with Composio

Overview

Enum

PHANTOMBUSTER

Description

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.

Authentication Details

api_key
stringRequired

Actions

Tool to fetch all agents associated with the current user or organization. use after validating your phantombuster api key to list available agents.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to get deleted agents for the current user or organization. use when you need to audit recently removed agents.

Action Parameters

Action Response

data
array
error
string
successful
boolean
Tool to get the length difference between the staging and release branch of all scripts. use when assessing branch changes before deployment.

Action Parameters

X-Phantombuster-Org
string
name
stringRequired

Action Response

data
array
error
string
successful
boolean
Tool to fetch all branches associated with the current organization. use when you need to enumerate every branch across your scripts.

Action Parameters

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

agentId
stringRequired

Action Response

data
object
error
string
successful
boolean
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")

Action Parameters

ip
string

Action Response

data
object
error
string
successful
boolean
Tool to export agent usage csv for current organization. use when you need a downloadable report of all agents' run statistics in csv format.

Action Parameters

agentId
string
days
integerRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

agentId
string
days
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to fetch current organization details. use when you need to retrieve the organization associated with the provided api key.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to get agent groups and order for the current organization. use when you need to review how agents are grouped and ordered.

Action Parameters

X-Phantombuster-Org
string

Action Response

data
object
error
string
successful
boolean
Tool to get current organization's resources and usage. use when you need to monitor quotas.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to get the current organization's running containers. use after listing agents to identify active containers across the organization.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to fetch all storage lists for the authenticated organization. use when you need to enumerate every storage list available (beta).

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to fetch all scripts for the current user. use after authenticating your phantombuster api key to list scripts without their code bodies.

Action Parameters

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to request a text completion from the ai module. use when you need to generate text based on a prompt.

Action Parameters

maxTokens
integer
model
string
n
integer
prompt
stringRequired
stop
array
temperature
number
topP
number

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

X-Phantombuster-Org
string
name
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a branch by id. use when you need to remove obsolete or incorrect script branches; ensure the branch exists before calling.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
status
string
successful
boolean
Tool to solve an hcaptcha challenge. use when you need a valid hcaptcha token for form submissions or automation flows.

Action Parameters

pageUrl
stringRequired
proxy
string
siteKey
stringRequired
userAgent
string

Action Response

data
object
error
string
successful
boolean