Phantombuster | Composio Docs

Overview

SLUG: 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

generic_api_key

stringRequired

generic_api_key

stringRequired

Connecting to Phantombuster

Create an auth config

Use the dashboard to create an auth config for the Phantombuster toolkit. This allows you to connect multiple Phantombuster accounts to Composio for agents to use.

Select App

Navigate to Phantombuster.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Phantombuster Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 phantombuster_auth_config_id = "ac_YOUR_PHANTOMBUSTER_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": user_api_key}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Phantombuster for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, phantombuster_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Phantombuster toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["PHANTOMBUSTER"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

PHANTOMBUSTER_GET_AGENTS_FETCH_ALL

Tool Name: Get All Agents

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_AGENTS_FETCH_DELETED

Tool Name: Get Deleted Agents

Description

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

arrayRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_BRANCHES_DIFF

Tool Name: Get Branches Diff

Description

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

arrayRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_BRANCHES_FETCH_ALL

Tool Name: Get All Branches

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_CONTAINERS_FETCH_ALL

Tool Name: Get Containers Fetch All

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_LOCATION_IP

Tool Name: Get IP Location

Description

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

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_ORGS_EXPORT_AGENT_USAGE

Tool Name: Export Agent Usage CSV

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_ORGS_EXPORT_CONTAINER_USAGE

Tool Name: Export Container Usage CSV

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_ORGS_FETCH

Tool Name: Get Organization

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_ORGS_FETCH_AGENT_GROUPS

Tool Name: Get Agent Groups

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_ORGS_FETCH_RESOURCES

Tool Name: Get Organization Resources

Description

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

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_ORGS_FETCH_RUNNING_CONTAINERS

Tool Name: Get Org Running Containers

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_ORG_STORAGE_LISTS_FETCH_ALL

Tool Name: Get Org Storage Lists Fetch All

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_GET_SCRIPTS_FETCH_ALL

Tool Name: Get All Scripts

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_POST_AGENTS_UNSCHEDULE_ALL

Tool Name: Unschedule All Agent Launches

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_POST_AI_COMPLETIONS

Tool Name: Request AI Completion

Description

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

integer

prompt

stringRequired

stop

array

temperature

number

topP

number

Action Response

data

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_POST_BRANCHES_CREATE

Tool Name: Create Branch

Description

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

objectRequired

error

string

successful

booleanRequired

PHANTOMBUSTER_POST_BRANCHES_DELETE

Tool Name: Delete Branch

Description

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

stringRequired

Action Response

data

objectRequired

error

string

status

stringRequired

successful

booleanRequired

PHANTOMBUSTER_POST_HCAPTCHA

Tool Name: Solve hCaptcha

Description

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

objectRequired

error

string

successful

booleanRequired