> **Building with AI coding agents?** If you're using an AI coding agent, install the official Scalekit plugin. It gives your agent full awareness of the Scalekit API — reducing hallucinations and enabling faster, more accurate code generation. > > - **Claude Code**: `/plugin marketplace add scalekit-inc/claude-code-authstack` then `/plugin install @scalekit-auth-stack` > - **GitHub Copilot CLI**: `copilot plugin marketplace add scalekit-inc/github-copilot-authstack` then `copilot plugin install @scalekit-auth-stack` > - **Codex**: run the bash installer, restart, then open Plugin Directory and enable `` > - **Skills CLI** (Windsurf, Cline, 40+ agents): `npx skills add scalekit-inc/skills --list` then `--skill ` > > `` / ``: `agent-auth`, `full-stack-auth`, `mcp-auth`, `modular-sso`, `modular-scim` — [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/) --- # PhantomBuster
Connect to PhantomBuster to automate web scraping and data extraction workflows. Launch, monitor, and manage automation agents that extract data from LinkedIn, Instagram, Twitter, and hundreds of other platforms.
PhantomBuster logo
Supports authentication: API Key ## Set up the agent connector ## Usage ## Tool list ## `phantombuster_agent_delete` Permanently delete a PhantomBuster agent and all its associated data. This action is irreversible. | Name | Type | Required | Description | | --- | --- | --- | --- | | `agentId` | string | Yes | The unique identifier of the agent to permanently delete. | ## `phantombuster_agent_fetch` Retrieve details of a specific PhantomBuster agent by its ID. Returns agent name, script, schedule, launch type, argument configuration, and current status. | Name | Type | Required | Description | | --- | --- | --- | --- | | `agentId` | string | Yes | The unique identifier of the agent to retrieve. | ## `phantombuster_agent_fetch_output` Get the output of the most recent container of an agent. Designed for incremental data retrieval — use fromOutputPos to fetch only new output since the last call. | Name | Type | Required | Description | | --- | --- | --- | --- | | `fromOutputPos` | number | No | Start output from this byte position (for incremental fetching). | | `id` | string | Yes | ID of the agent to fetch output from. | | `prevContainerId` | string | No | Retrieve output from the container after this previous container ID. | | `prevRuntimeEventIndex` | number | No | Return runtime events starting from this index. | | `prevStatus` | string | No | Previously retrieved status from user-side (for delta detection). | ## `phantombuster_agent_launch` Launch a PhantomBuster automation agent asynchronously. Starts the agent execution immediately and returns a container ID to track progress. Use the Get Container Output or Get Container Result tools to retrieve results. | Name | Type | Required | Description | | --- | --- | --- | --- | | `agentId` | string | Yes | The unique identifier of the agent to launch. | | `arguments` | `object` | No | JSON object of input arguments to pass to the agent for this execution. | | `output` | string | No | Output mode for the launch response. | | `saveArguments` | boolean | No | Whether to persist the provided arguments as the agent's default arguments for future launches. | ## `phantombuster_agent_launch_soon` Schedule a PhantomBuster agent to launch within a specified number of minutes. Useful for delayed execution without setting up a full recurring schedule. | Name | Type | Required | Description | | --- | --- | --- | --- | | `argument` | `object` | No | Input arguments to pass to the agent for this execution (object or JSON string). | | `id` | string | Yes | ID of the agent to schedule. | | `minutes` | integer | Yes | Number of minutes from now after which the agent will launch. | | `saveArgument` | boolean | No | If true, saves the provided argument as the agent's default for future launches. | ## `phantombuster_agent_save` Create a new PhantomBuster agent or update an existing one. Supports configuring the script, schedule, proxy, notifications, execution limits, and launch arguments. Pass an ID to update; omit to create. | Name | Type | Required | Description | | --- | --- | --- | --- | | `argument` | `object` | No | Default launch argument for the agent (object or JSON string). | | `branch` | string | No | Script branch to use (e.g., main, staging). | | `executionTimeLimit` | number | No | Maximum execution time in seconds before the agent is killed. | | `id` | string | No | ID of the agent to update. Omit to create a new agent. | | `launchType` | string | No | How the agent is launched. | | `maxParallelism` | number | No | Maximum number of concurrent executions allowed for this agent. | | `maxRetryNumber` | number | No | Maximum number of retries before aborting on failure. | | `name` | string | No | Display name for the agent. | | `proxyAddress` | string | No | HTTP proxy address or proxy pool name. | | `proxyPassword` | string | No | Proxy authentication password. | | `proxyType` | string | No | Proxy configuration type. | | `proxyUsername` | string | No | Proxy authentication username. | | `script` | string | No | Script slug or name to assign to this agent. | ## `phantombuster_agent_stop` Stop a currently running PhantomBuster agent execution. Gracefully halts the agent and saves any partial results collected up to that point. | Name | Type | Required | Description | | --- | --- | --- | --- | | `agentId` | string | Yes | The unique identifier of the agent to stop. | ## `phantombuster_agents_fetch_all` Retrieve all automation agents in the PhantomBuster organization. Returns agent IDs, names, associated scripts, schedules, and current status. ## `phantombuster_agents_fetch_deleted` Retrieve all deleted agents in the PhantomBuster organization. Returns agent IDs, names, creation timestamps, deletion timestamps, and who deleted each agent. ## `phantombuster_agents_unschedule_all` Disable automatic launch for ALL agents in the current PhantomBuster organization. Agents will remain but will only run when launched manually. ## `phantombuster_ai_completions` Get an AI text completion from PhantomBuster's AI service. Supports multiple models including GPT-4o and GPT-4.1-mini. Optionally request structured JSON output via a response schema. | Name | Type | Required | Description | | --- | --- | --- | --- | | `messages` | `array` | Yes | Array of conversation messages. Each must have a role (system, assistant, or user) and content string. | | `model` | string | No | AI model to use for the completion. | | `temperature` | number | No | Sampling temperature (0–2). Lower = more deterministic, higher = more creative. | ## `phantombuster_branch_create` Create a new script branch in the current PhantomBuster organization. | Name | Type | Required | Description | | --- | --- | --- | --- | | `name` | string | Yes | Name for the new branch. Only letters, numbers, underscores, and hyphens allowed. Max 50 characters. | ## `phantombuster_branch_delete` Permanently delete a branch by ID from the current PhantomBuster organization. | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | Yes | ID of the branch to delete. | ## `phantombuster_branch_release` Release (promote to production) specified scripts on a branch in the current PhantomBuster organization. | Name | Type | Required | Description | | --- | --- | --- | --- | | `name` | string | Yes | Name of the branch to release. | | `scriptIds` | `array` | Yes | Array of script IDs to release on this branch. | ## `phantombuster_branches_fetch_all` Retrieve all branches associated with the current PhantomBuster organization. ## `phantombuster_container_attach` Attach to a running PhantomBuster container and stream its console output in real-time. Returns a live stream of log lines as the agent executes. | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | Yes | ID of the running container to attach to. | ## `phantombuster_container_fetch` Retrieve a single PhantomBuster container by its ID. Returns status, timestamps, launch type, exit code, and optionally the full output, result object, and runtime events. | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | Yes | ID of the container to fetch. | | `withNewerAndOlderContainerId` | boolean | No | Set to true to include the IDs of the next and previous containers for this agent. | | `withOutput` | boolean | No | Set to true to include the container's console output. | | `withResultObject` | boolean | No | Set to true to include the container's result object. | | `withRuntimeEvents` | boolean | No | Set to true to include runtime events (progress, notifications, etc.). | ## `phantombuster_container_fetch_output` Retrieve the console output and execution logs of a specific PhantomBuster container (agent run). Useful for monitoring execution progress, debugging errors, and viewing step-by-step agent activity. | Name | Type | Required | Description | | --- | --- | --- | --- | | `containerId` | string | Yes | The unique identifier of the container whose output to retrieve. | ## `phantombuster_container_fetch_result` Retrieve the final result object of a completed PhantomBuster container (agent run). Returns the structured data extracted or produced by the agent, such as scraped profiles, leads, or exported records. | Name | Type | Required | Description | | --- | --- | --- | --- | | `containerId` | string | Yes | The unique identifier of the container whose result to retrieve. | ## `phantombuster_containers_fetch_all` Retrieve all execution containers (past runs) for a specific PhantomBuster agent. Returns container IDs, status, launch type, exit codes, timestamps, and runtime events for each execution. | Name | Type | Required | Description | | --- | --- | --- | --- | | `agentId` | string | Yes | The unique identifier of the agent whose containers to retrieve. | ## `phantombuster_leads_delete_many` Permanently delete multiple leads from PhantomBuster organization storage by their IDs. | Name | Type | Required | Description | | --- | --- | --- | --- | | `ids` | `array` | Yes | Array of lead IDs to delete. | ## `phantombuster_leads_fetch_by_list` Fetch paginated leads belonging to a specific lead list in PhantomBuster organization storage. | Name | Type | Required | Description | | --- | --- | --- | --- | | `includeTotalCount` | boolean | No | Include the total count of leads in the response. | | `listId` | string | Yes | ID of the lead list to fetch leads from. | | `paginationOffset` | integer | No | Offset for pagination. | | `paginationOrder` | string | No | Sort order for pagination. | | `paginationSize` | integer | No | Number of leads per page. | ## `phantombuster_leads_save` Save a single lead to PhantomBuster organization storage. | Name | Type | Required | Description | | --- | --- | --- | --- | | `lead` | `object` | Yes | Lead data object to save. | ## `phantombuster_leads_save_many` Save multiple leads at once to PhantomBuster organization storage. | Name | Type | Required | Description | | --- | --- | --- | --- | | `leads` | `array` | Yes | Array of lead objects to save. | ## `phantombuster_list_delete` Permanently delete a lead list from PhantomBuster organization storage by its ID. | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | Yes | ID of the lead list to delete. | ## `phantombuster_list_fetch` Retrieve a specific lead list from PhantomBuster organization storage by its ID. | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | Yes | ID of the lead list to fetch. | ## `phantombuster_lists_fetch_all` Retrieve all lead lists in the PhantomBuster organization's storage. ## `phantombuster_location_ip` Retrieve the country associated with an IPv4 or IPv6 address using PhantomBuster's geolocation service. | Name | Type | Required | Description | | --- | --- | --- | --- | | `ip` | string | Yes | IPv4 or IPv6 address to look up. | ## `phantombuster_org_export_agent_usage` Export a CSV file containing agent usage metrics for the current PhantomBuster organization over a specified number of days (max 6 months). | Name | Type | Required | Description | | --- | --- | --- | --- | | `days` | string | Yes | Number of days of usage data to export. Maximum is ~180 days (6 months). | ## `phantombuster_org_export_container_usage` Export a CSV file containing container usage metrics for the current PhantomBuster organization. Optionally filter to a specific agent. | Name | Type | Required | Description | | --- | --- | --- | --- | | `agentId` | string | No | Filter the export to a specific agent ID. | | `days` | string | Yes | Number of days of usage data to export. Maximum is ~180 days (6 months). | ## `phantombuster_org_fetch` Retrieve details of the current PhantomBuster organization including plan, billing, timezone, proxy config, and CRM integrations. | Name | Type | Required | Description | | --- | --- | --- | --- | | `withCrmIntegrations` | boolean | No | Include the organization's CRM integrations. | | `withCustomPrompts` | boolean | No | Include the organization's custom prompts. | | `withGlobalObject` | boolean | No | Include the organization's global object in the response. | | `withProxies` | boolean | No | Include the organization's proxy pool configuration. | ## `phantombuster_org_fetch_agent_groups` Retrieve the agent groups and their ordering for the current PhantomBuster organization. ## `phantombuster_org_fetch_resources` Retrieve the current PhantomBuster organization's resource usage and limits. Returns daily and monthly usage for execution time, mail, captcha, AI credits, SERP credits, storage, and agent count. ## `phantombuster_org_fetch_running_containers` List all currently executing containers across the PhantomBuster organization. Returns container IDs, associated agent IDs/names, creation timestamps, launch types, and script slugs. ## `phantombuster_org_save_agent_groups` Update the agent groups and their ordering for the current PhantomBuster organization. The order of groups and agents within groups is preserved as provided. | Name | Type | Required | Description | | --- | --- | --- | --- | | `agentGroups` | `array` | Yes | Array of agent groups. Each item is either an agent ID string or an object with id, name, and agents array. | ## `phantombuster_org_save_crm_contact` Save a new contact to the organization's connected CRM (HubSpot). Requires a CRM integration to be configured in the PhantomBuster organization settings. | Name | Type | Required | Description | | --- | --- | --- | --- | | `company` | string | No | Company the contact works at. | | `crmName` | string | Yes | The CRM to save the contact to. | | `email` | string | No | Contact's email address. | | `firstname` | string | Yes | Contact's first name. | | `jobtitle` | string | No | Contact's job title. | | `lastname` | string | Yes | Contact's last name. | | `pb_linkedin_profile_url` | string | Yes | LinkedIn profile URL of the contact. | | `phone` | string | No | Contact's phone number. | ## `phantombuster_script_fetch` Retrieve a specific PhantomBuster script by ID including its manifest, argument schema, output types, and optionally the full source code. | Name | Type | Required | Description | | --- | --- | --- | --- | | `branch` | string | No | Branch of the script to fetch. | | `id` | string | Yes | ID of the script to fetch. | | `withCode` | boolean | No | Set to true to include the script's source code in the response. | ## `phantombuster_scripts_fetch_all` Retrieve all scripts associated with the current PhantomBuster user. Returns script IDs, names, slugs, descriptions, branches, and manifest details. | Name | Type | Required | Description | | --- | --- | --- | --- | | `branch` | string | No | Filter scripts by branch name. | | `exclude` | string | No | Exclude modules or non-modules from results. | | `org` | string | No | Filter scripts by organization. | --- ## More Scalekit documentation | Resource | What it contains | When to use it | |----------|-----------------|----------------| | [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content | | [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas | | [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |