Anchor Browser Docs

Docs

Ad Blocker: Block ads, trackers, and unwanted content in your browser sessions
Anchor VPN: Integrated VPN egress that is secure, reliable, and fast - beyond what proxy setups can offer.
Batch Browser Sessions: Create and manage multiple browser sessions simultaneously for large-scale automation tasks
Embedded Browser Live UI: Embed interactive browser sessions directly into your application
CA Certificates: Install custom CA certificates to trust internal services and private PKI in browser sessions.
Captcha Solving
Cloudflare Web Bot Auth: Authenticate browser sessions with Cloudflare Web Bot Auth
Dedicated Sticky IP: Reserve a fixed IP address for a specific profile.
Demonstrations API: Let external users record browser workflows via a shareable link
Email MFA: Email-based MFA for identity creation, reauthentication, and agent sessions.
Browser Extensions: Upload and use custom browser extensions in your sessions
File Download
File Upload
Manually Editing Workflows: Schema reference for hand-editing Anchor Browser workflow JSON, and how to push changes via the API.
MCP - Hosted Version: Use Anchor with Model Context Protocol (MCP) in your preferred agentic tools via our hosted service
MCP - Open Source: Self-host Anchor MCP server with customizable Playwright integration for your specific needs
MFA: Real-time event signaling and coordination between external systems and browser instances
OS-Level Control: Direct operating system control for precise browser automation and AI agent interactions
P2P Download: Receive download events in real time and fetch files directly from the browser
Popup Blocker: Block cookie banners and consent dialogs in your browser sessions
Proxy
Sensitive Data Masking: Automatically detect and mask sensitive data like passwords, emails, phone numbers, and credit cards in your browser sessions
Session Tags: Organize and track browser sessions with custom labels
Session Timeout
Automation Tasks: Create, manage, and execute reusable browser automation tasks
Web Unlocker: Fetch content from any webpage — including bot-protected sites — with a single API call.
CrewAI
Custom Integration
LangChain
Agentic File Usage: Upload ZIP files to browser sessions for AI agents to use
AI Task Completion
Async Perform Web Task: Run perform-web-task asynchronously and poll for results
Anthropic Computer Use: Use Claude models with native computer use capabilities for browser automation
Gemini Computer Use: Use Google Gemini models for screenshot-based browser automation
OpenAI Computer Use: Use OpenAI models with computer use capabilities for browser automation
Yutori Browser Use: Build browser-use agents with Yutori n1 — state-of-the-art browser-use model
Human-in-the-Loop: Enable human intervention during AI agent task execution
Secret Values: Securely pass credentials and sensitive data to AI agents
Get Agent Status: Returns the status of the in-session AI agent. Requires the session to be running.
Get Requested Human Intervention: Returns a pending human-intervention request from the in-session agent, if any.
List Agent Resources: List all resources that have been uploaded to the browser session for agent use. Returns resource metadata including name, size, type, and last modified timestamp.
Pause Agent: Pauses the AI agent for the specified browser session.
Respond to Human Intervention: Submits a response to a pending human-intervention request from the in-session agent.
Resume Agent: Resumes the AI agent for the specified browser session.
Run Agent Task: Runs a perform-web-task on the running session's in-session agent. Requires the session to be running. See AI task completion.
Upload Agent Resources: Upload files as agent resources to a browser session using multipart/form-data. If you upload a ZIP file, it will be automatically extracted and the files will be made available as agent resources. If you upload a single file, it will be saved directly as an agent resource. Resources are then acces…
Get Perform Web Task Status: Get the status of an asynchronous perform-web-task execution by workflow ID.
Perform Web Task: Start from a URL and perform the given task.
Create Application: Creates a new application for identity management.
Create Authentication Flow: Creates a new authentication flow for an application.
Create Identity Token: Creates an identity token for a specific application. This token is used to initiate an authentication flow for linking user identities to the application.
Delete Application: Deletes an existing application.
Delete Authentication Flow: Deletes an existing authentication flow.
Get Application: Retrieves details of a specific application by its ID.
List Application Authentication Flows: Retrieves all authentication flows for a specific application.
List Application Identities: Retrieves all identities associated with a specific application.
List Applications: Retrieves all applications for the authenticated team.
Update Authentication Flow: Updates an existing authentication flow.
Create Batch Sessions: Creates multiple browser sessions in a single batch operation. This endpoint allows you to create up to 5,000 browser sessions simultaneously with the same configuration.
Delete Batch Sessions: Deletes all sessions in a batch. Running sessions will be terminated and all session data will be removed.
Get Batch Session Status: Retrieves detailed status information for a specific batch, including progress, individual session details, and any errors that occurred.
List Batch Sessions: Lists all batch session requests for the authenticated team, with optional filtering by status and pagination support.
Retry Failed Batch Sessions: Retries failed sessions in a batch by creating new browser pods for each failed session. The batch status will be set back to 'processing'.
Update Batch Session: Updates a batch session. Supports cancelling a running or pending batch, which terminates all running sessions in the batch.
Get Billing Info: Retrieves credit balance, current-period credit usage, tier, and billing limits for the authenticated project.
Async Session Status: Polling endpoint paired with POST /v1/sessions/async. Returns the current lifecycle status of the async request and, once the pod is up, the embedded session object containing session_id, cdp_url and live_view_url.
End All Sessions: Terminates all active browser sessions associated with the provided API key.
End Browser Session: Deletes the browser session associated with the provided browser session ID. Requires a valid API key for authentication.
Fetch Session Download: Returns a pre-signed URL (wrapped in data) to fetch a file downloaded during the session.
Get Active Page: Returns the active page (URL/title) currently open in the session's browser.
Get Browser Session: Retrieves detailed information about a specific browser session.
Get Browser Session Pages: Retrieves a list of pages associated with a specific browser session.
Get Session Auth Status: Returns the identity-authentication status and tasks for a session.
Get Sessions History: Retrieves session usage analytics for the authenticated team.
List All Sessions Status: Retrieves status information for all browser sessions associated with the API key.
List Session Downloads: Retrieves metadata of files downloaded during a browser session. Requires a valid API key for authentication.
List Session Task Executions: Returns a paginated list of (non-internal) task executions that ran on the session.
List Sessions History Page: Retrieves a paginated list of sessions for the authenticated team with support for sorting and advanced filtering. This endpoint mirrors the backend session history-page filtering behavior.
Start Browser Session: Allocates a new browser session for the user, with optional configurations for ad-blocking, captcha solving, proxy usage, and idle timeout.
Start Browser Session (async): Non-blocking variant of POST /v1/sessions. Returns a request_id immediately and provisions the underlying browser pod in the background. Poll GET /v1/sessions/async/{request_id}/status until status becomes ready to obtain the resolved session_id, cdp_url and live_view_url.
Upload Files: Upload files directly to a browser session for use with web forms and file inputs.
Delete Certificate: Delete a CA certificate by name. The certificate will be removed from storage and can no longer be used in new sessions.
List Certificates: Get all CA certificates uploaded for the team
Upload Certificate: Upload a CA certificate to trust in browser sessions. Certificates are managed at the team level. Once uploaded, reference the certificate by name when creating sessions to trust services using that CA.
Signal Event: Signals an event with associated data, unblocking any clients waiting for this event. This enables coordination between different browser sessions, workflows, or external processes.
Wait for Event: Waits for a specific event to be signaled by another process, workflow, or session. This endpoint blocks until the event is signaled or the timeout is reached. Useful for coordinating between multiple browser sessions or workflows.
Fetch Execution Artifact: Downloads a single artifact. By default responds with a 302 redirect to a pre-signed URL. Pass format=url to receive the pre-signed URL as JSON instead.
Get Execution: Retrieves the result of a single task or tool execution, including its status, output, inputs, and timing. Secret values in output and inputs are redacted according to the task's parameter schema.
Get Execution Logs: Returns the structured log entries captured during an execution.
Get Execution Metadata: Returns task and version metadata for an execution. When the execution ran in a browser session, also includes raw network-recorder and browser-action artifacts.
Get Execution Page States: Returns captured page-state snapshots for an execution that ran in a browser session, keyed by workflow segment name. Optionally filter to specific segments.
List Execution Artifacts: Lists files produced during an execution (generated artifacts and downloaded files), each with a pre-signed downloadUrl.
Delete Extension: Delete an extension and remove it from storage
Get Extension Details: Get details of a specific extension by its ID
List Extensions: Get all extensions for the authenticated user
Upload Extension: Upload a new browser extension as a ZIP file. The extension will be validated and stored for use in browser sessions.
Create Identity: Creates a new identity for the given source. Credentials are optional.
Create Mailbox: Creates a detached mailbox (not yet attached to an identity). Useful for revealing an inbox address before identity creation, then attaching it via the identity API.
Delete Identity: Deletes an existing identity.
Disable Identity Mailbox: Detaches the mailbox from the identity and deletes it if unused by other identities.
Enable Identity Mailbox: Creates and attaches a mailbox to an identity, or returns the existing one.
Get Identity: Retrieves details of a specific identity by its ID.
Get Identity Email: Returns the full content of a specific email in the identity's mailbox.
Get Identity Mailbox: Returns the identity's mailbox details, or null if none is attached.
List Identity Emails: Lists emails received by the identity's mailbox, newest first.
List Mailbox Emails: Lists emails received by a mailbox, newest first.
Send Mailbox Probe: Sends a probe email (via SES) to verify mailbox delivery.
Update Identity: Updates an existing identity's name, metadata, or credentials.
Create Integration: Creates a new integration with a third-party service like 1Password. The integration can then be used in browser sessions to automatically load secrets and credentials.
Delete Integration: Deletes an existing integration and removes its stored credentials.
List Integrations: Retrieves all integrations for the authenticated team.
Copy Selected Text: Copies the currently selected text to the clipboard
Drag and Drop: Performs a drag and drop operation from start coordinates to end coordinates
Get Clipboard Content: Retrieves the current content of the clipboard
Keyboard Shortcut: Performs a keyboard shortcut using the specified keys
Mouse Click: Performs a mouse click at the specified coordinates
Mouse Double Click: Performs a double click at the specified coordinates
Mouse Down: Performs a mouse button down action at the specified coordinates
Mouse Move: Moves the mouse cursor to the specified coordinates
Mouse Up: Performs a mouse button up action at the specified coordinates
Navigate to URL: Navigates the browser session to the specified URL
Paste Text: Pastes text at the current cursor position
Press Keys: Presses one or more keys in the session's browser (OS-level input).
Reset Browser Context: Resets the browser context for a running session (clears cookies/storage for the context).
Scroll: Performs a scroll action at the specified coordinates
Set Clipboard Content: Sets the content of the clipboard
Take Screenshot: Takes a screenshot of the current browser session and returns it as an image.
Type Text: Types the specified text with optional delay between keystrokes
Create Profile: Creates a new profile from a browser session. A Profile stores cookies, local storage, and cache.
Create Profile Session: Starts a short-lived browser session bound to a saved profile (persisting cookies and storage back to the profile on termination). Returns CDP and live-view URLs.
Delete Profile: Deletes an existing profile by its name.
Delete Profile Session: Terminates a profile-bound browser session.
Get Profile: Retrieves details of a specific profile by its name.
List Profiles: Fetches all stored profiles.
Add Project Member: Adds a member to the project by email.
Create Project: Creates a new project (team/workspace) owned by the authenticated user.
Create Project API Key: Creates a new API key for the project. The full key value is returned once.
Delete Project: Deletes a project. Personal projects cannot be deleted.
Delete Project API Key: Revokes an API key. The project's default key cannot be deleted.
Get Project: Retrieves a project by ID. The caller must be a member of the project.
Get Project Credits: Returns the project's credit balance, tier, concurrency limit, and cost limit.
Get Project LLM Model Policy: Returns the project's LLM model policy, or null if none is set.
Get Project Metadata: Returns lightweight project metadata (name, domain, logo).
List Project API Keys: Lists active API keys for the project.
List Project Members: Lists members of the project.
List Projects: Lists all projects the authenticated user is a member of.
Remove Project Logo: Removes the project's logo.
Remove Project Member: Removes a member from the project. You cannot remove yourself or the owner of a personal project.
Rename Project: Updates a project's name. The caller must be a member of the project.
Update Project API Key: Updates an API key's name and/or marks it as the project default.
Update Project LLM Model Policy: Sets or clears the project's LLM model policy.
Upload Project Logo: Uploads or replaces the project logo. Allowed types: PNG, JPEG, WebP, SVG, ICO.
Get Session Agent Logs: Returns the agent log lines captured during a session.
Get Session Browser-Action Logs: Returns the browser-action log lines captured during a session.
Get Session Network-Response Logs: Returns the network-response log lines captured during a session.
Delete Session Recording: Deletes a specific recording from a browser session. Use "primary" as the recording_id to delete the primary recording.
Fetch Session Recording: Redirects (302) to a pre-signed URL for a specific session recording. This route does not require an API key (shareable). The session must no longer be active.
Get Session Recording: Downloads the primary recording file for the specified browser session. Returns the recording as an MP4 file.
List Session Recordings: Retrieves the URLs of the browser session's video recordings. Requires a valid API key for authentication.
Pause Session Recording: Pauses the video recording for the specified browser session.
Resume Session Recording: Resumes the video recording for the specified browser session.
Create or Update Task Draft (Legacy): Creates or updates the draft version of a task. Draft versions are used for development and testing before publishing.
Create Task (Legacy): Creates a new task or updates an existing task with the same name. Tasks are reusable code snippets that can be executed in browser sessions. Tasks support versioning with draft and published versions.
Delete Task (Legacy): Soft deletes a task and all its versions. The task will no longer be accessible but the data is preserved for potential recovery.
Delete Task Version (Legacy): Soft deletes a specific version of a task. The version will no longer be accessible but the data is preserved for potential recovery.
Deploy Task (Legacy): Deploys a task by creating a new version with auto-incremented version number. This is the recommended way to publish task changes.
Get Latest Task Version (Legacy): Retrieves the latest version of a task, including the full code content.
Get Task Draft (Legacy): Retrieves the draft version of a task, including the full code content.
Get Task Execution Result (Legacy): Retrieves a single execution result by its ID. This endpoint is useful for polling execution status in async mode or retrieving detailed execution information.
Get Task Metadata (Legacy): Retrieves task metadata without the code content. Useful for getting task information without downloading the full task code.
Get Task Version (Legacy): Retrieves a specific version of a task, including the full code content.
List Task Executions (Legacy): Retrieves execution history for a task, including success/failure status, execution times, and outputs. Results can be filtered by version and status.
List Task Versions (Legacy): Retrieves all versions of a specific task, including draft and published versions.
List Tasks (Legacy): Retrieves a paginated list of all tasks for the authenticated team. Tasks are returned with their latest version information and metadata.
Publish Task Version (Legacy): Publishes a specific version of a task. This creates a new version if it doesn't exist, or updates an existing version's metadata.
Run Task by Name (Legacy): Executes a task by its name, always using the latest version. This is a convenience endpoint for running tasks without needing to know the task ID.
Run Task (Legacy): Executes a task in a browser session. The task can be run with a specific version or the latest version. Optionally, you can provide an existing session ID or let the system create a new one.
Update Task Metadata (Legacy): Updates task metadata (name and description). This does not affect the task code or versions.
Edit Task: Edits a task/tool via a natural-language instruction, producing an updated draft.
Generate Task: Starts AI generation of a new task/tool from a natural-language user_task. Poll GET /v2/tasks/{taskId}/generation-status until it is ready.
Get Task Generation Status: Polls the status of an in-progress task generation.
Get Task Run Status: Retrieves the current status and result of a task run in the non-deprecated Tasks endpoints.
List Task Versions: Lists all versions of a task/tool, including the current version and any draft.
Publish Task Draft: Publishes the task's draft version to production.
Run a Task: Triggers execution of a task by ID using the non-deprecated Tasks endpoints.
Create Tool: Creates a tool. Provide an existing taskId or hektor_project_id, or omit both to import a default agentic tool generated from name and description.
Delete Tool: Deletes a tool and its backing task.
Extract Tool Parameters: Uses AI to derive suggested input/output parameters and a name from a task description.
Get Page PDF: Generates a PDF of the current page for a browser session and returns it as a binary PDF file.
Get Tool: Retrieves a tool by ID, including its input/output parameter schemas.
Get Tool Stats: Returns execution statistics for a tool.
Get Webpage Content: Retrieve the rendered content of a webpage in Markdown or HTML format. Text content is also extracted from PDFs.
List Tool Executions: Returns a paginated list of executions for a tool.
List Tools: Lists the team's tools, optionally filtered by a search term.
Screenshot Webpage: This endpoint captures a screenshot of the specified webpage using Chromium. Users can customize the viewport dimensions and capture options.
Start Tool Demonstration: Starts a browser session for demonstrating (recording) a tool workflow.
Stop Tool Demonstration: Stops a tool demonstration session.
Take Over Tool Demonstration: Pauses the agent and hands control of the demonstration session to the human user.
Update Tool: Updates a tool's name, description, default browser configuration, or human-intervention flag.
Web Unlocker: Fetch fully-rendered page content from any URL — including bot-protected sites — without managing a browser session. Requests are routed through stealth browsers with residential proxies, captcha solving, and fingerprint randomization. No session is required. See the [Web Unlocker guide](/advanced/w…
Web Unlocker Fetch: Runs a billed, rate-limited web-unlocker fetch tool (e.g. scrape/unblock a URL). The response shape depends on the tool. See the Web Unlocker guide.
Create Webhook: Register a new HTTPS endpoint to receive events. The response includes a one-time secret (HMAC-SHA256 signing key) — store it; Anchor never returns it again. Up to 5 webhooks per project.
Delete Webhook: Soft-delete a webhook. New events stop fanning out immediately. The events history (/v1/webhooks/{id}/events) is still queryable for the retention window even after delete.
Get Webhook: Fetch a single webhook config. The signing secret is never returned.
List Webhook Deliveries: Paginated history of every delivery attempt for this webhook (succeeded, failed, or dead-lettered). Filter by status, event type, or time range. Retention: 7 days.
List Webhooks: List every active webhook for the authenticated project. The signing secret is never included.
Rotate Webhook Signing Secret: Mint a new HMAC-SHA256 signing secret. The previous secret remains valid for 24 hours so you can update your verification code at your own pace, then drop the old secret.
Send Test Event: Fire a synthetic event of the given type through the real signing + retry path. Useful during development for confirming your endpoint can verify the signature and is reachable from Anchor's egress IPs.
Update Webhook: Partial update — pass only the fields you want to change. Setting enabled: false immediately stops events from fanning out to this webhook (existing in-flight deliveries finish their attempts).
Async Session: Create browser sessions without blocking and poll until they are ready
Authentication (OmniConnect): Equip your agent with a persistent identity, enabling seamless access to applications without repeated logins
Embedding End-User Authentication UI: Anchor's embeddable flow so your end users can sign in to third-party sites from your product; identities power authenticated browser sessions.
Session Recording: Record browser sessions for debugging, analysis, and documentation
Extra Stealth Mode: Advanced anti-detection and browser fingerprinting protection for automated browsing
Tools - Browser Control API
Buyer Intent Discovery
Configuration Collection
Form Filling Automation
Deep Research
1Password: Securely inject 1Password secrets into your browser sessions
Browser-use
Groq GPT-OSS: Blazing Fast, Accurate Browser Agents
Make: Integrate Anchor Browser with Make (formerly Integromat) for no-code automation workflows
n8n: Integrate Anchor Browser with n8n for no-code automation workflows
Airtable: Automate Airtable database workflows with Playwright when APIs aren't available.
Attio: Automate Attio CRM workflows with Playwright when APIs aren't available.
Bill.com: Automate Bill.com accounts payable workflows with Playwright when APIs aren't available.
Clickup: Automate ClickUp project management workflows with Playwright when APIs aren't available.
CrowdStrike: Automate CrowdStrike security workflows with Playwright when APIs aren't available.
DocuSign: Automate DocuSign electronic signature workflows with Playwright when APIs aren't available.
Dropbox: Automate Dropbox file management workflows with Playwright when APIs aren't available.
Figma: Automate Figma design workflows with Playwright when APIs aren't available.
HubSpot: Automate HubSpot CRM workflows with Playwright when APIs aren't available.
Jira: Automate Jira project management workflows with Playwright when APIs aren't available.
Miro: Automate Miro collaboration workflows with Playwright when APIs aren't available.
Monday: Automate Monday.com project management workflows with Playwright when APIs aren't available.
NetSuite: Automate NetSuite business workflows with Playwright when APIs aren't available.
Notion: Automate Notion workspace workflows with Playwright when APIs aren't available.
Pipedrive: Automate Pipedrive CRM workflows with Playwright when APIs aren't available.
Sage Intact: Automate Sage Intacct financial workflows with Playwright when APIs aren't available.
Salesforce: Automate Salesforce CRM workflows with Playwright when APIs aren't available.
SAP S/4HANA: Automate SAP S/4HANA business workflows with Playwright when APIs aren't available.
ServiceNow: Automate ServiceNow IT service management workflows with Playwright when APIs aren't available.
Tableau: Automate Tableau dashboard workflows with Playwright when APIs aren't available.
UiPath: Automate UiPath RPA management workflows with Playwright when APIs aren't available.
Wrike: Automate Wrike project management workflows with Playwright when APIs aren't available.
Zendesk: Automate Zendesk customer service workflows with Playwright when APIs aren't available.
Apache Superset: Test Apache Superset dashboards and data visualization workflows with Playwright's end-to-end testing framework.
Grafana: Test Grafana dashboards and monitoring workflows with Playwright's end-to-end testing framework.
OpenHands: Test OpenHands' AI-driven software development workflows with Playwright's end-to-end testing framework.
Storybook: Test Storybook components with Playwright's component testing framework.
Twenty: Test Twenty CRM workflows with Playwright's end-to-end testing framework.
BLM Form 3510: Automate BLM mineral operations reporting workflows with Playwright when APIs aren't available.
BOP Form BP-S0243: Automate Bureau of Prisons inmate request workflows with Playwright when APIs aren't available.
CBP Form 7501: Automate CBP Form 7501 entry documentation workflows with Playwright when APIs aren't available.
CCC Form 941: Automate USDA farm program income certification workflows with Playwright when APIs aren't available.
CMS Form 10069: Automate Medicare provider enrollment and certification workflows with Playwright when APIs aren't available.
DOE Form 1845-0031: Automate federal student loan forbearance request workflows with Playwright when APIs aren't available.
DOJ Form 361: Automate Department of Justice identity certification workflows with Playwright when APIs aren't available.
EPA Form 8700-22: Automate EPA hazardous waste notification workflows with Playwright when APIs aren't available.
FDA Form 2579: Automate FDA food facility registration workflows with Playwright when APIs aren't available.
FinCEN 105 (CMIR): Automate FinCEN 105 currency reporting workflows with Playwright when APIs aren't available.
FMCSA Form BMC-40: Automate motor carrier surety bond and trust fund filing workflows with Playwright when APIs aren't available.
FMCSA Form OP-1: Automate motor carrier operating authority application workflows with Playwright when APIs aren't available.
FMCSA Form OP-1(P): Automate motor carrier passenger operating authority application workflows with Playwright when APIs aren't available.
Form 122A-1: Automate Chapter 7 bankruptcy means test and income statement workflows with Playwright when APIs aren't available.
FS Form 5444: Automate TreasuryDirect account authorization workflows with Playwright when APIs aren't available.
FSA Form 578: Automate USDA farm commodity storage report workflows with Playwright when APIs aren't available.
IRS Form 8300: Automate IRS Form 8300 cash payment reporting workflows with Playwright when APIs aren't available.
IRS Form W-7: Automate ITIN application workflows with Playwright when APIs aren't available.
OWCP Form 915: Automate federal workers' compensation claim workflows with Playwright when APIs aren't available.
USCIS Form I-9: Automate employment eligibility verification workflows with Playwright when APIs aren't available.
VA Form 21-526EZ: Automate VA disability compensation application workflows with Playwright when APIs aren't available.
Integrate Playwright with Anchor Browser: Integrate Playwright and Anchor Browser
Integrate Puppeteer with Anchor Browser: Integrate Puppeteer and Anchor Browser
Stagehand: Integrate Stagehand with Anchor Browser for AI-powered browser automation
Documentation: Welcome to Anchor Browser
Pricing: Simple, transparent pricing for Anchor Browser automation platform
API Quick Start
Code Quick Start
SDK Quick Start
Trust & Security
Zero Data Retention (ZDR) Mode: Enhanced security mode that disables all video and log recordings to prevent sensitive data retention
Events: Catalog of webhook event types and the JSON payload each one carries.
Overview: Receive real-time notifications when tasks, sessions and identities complete, fail, or need human input.
Signature verification: Verify that webhook requests really came from Anchor using HMAC-SHA256 and timestamp-based replay protection.

OpenAPI Specs

Optional

Interactive Playground