# Hyperbrowser

Hyperbrowser is a next-generation platform empowering AI agents and enabling effortless, scalable browser automation.

- **Category:** ai web scraping
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 44
- **Triggers:** 0
- **Slug:** `HYPERBROWSER`
- **Version:** 20260316_00

## Tools

### Add Extension

**Slug:** `HYPERBROWSER_ADD_EXTENSION`

Tool to add a new browser extension to Hyperbrowser for use in sessions. Use when you need to upload a Chrome extension zip file that can be loaded into browser sessions. The extension zip must contain a valid manifest.json file at the root level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Chrome extension zip file to upload. The zip must contain a valid manifest.json at the root level. |
| `name` | string | No | Optional display name for the extension. If not provided, the filename will be used as the extension name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Hyperbrowser Profile

**Slug:** `HYPERBROWSER_CREATE_PROFILE`

Creates a new persistent Hyperbrowser profile for storing browser state (cookies, sessions, etc.). Use this to create a reusable profile that can be attached to browser sessions via the profile ID. Profiles allow you to maintain logged-in states across multiple sessions without re-authenticating.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional profile name for easy identification. If not provided, an unnamed profile will be created. Must be at least 1 character if specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Scrape Job

**Slug:** `HYPERBROWSER_CREATE_SCRAPE_JOB`

Tool to initiate a new scrape job. Use when you need to extract structured content from a target URL with custom session and scrape settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Target URL to scrape |
| `scrapeOptions` | object | No | Scrape behavior configuration Key options: `onlyMainContent` (bool, omits boilerplate/nav content), `waitFor` (ms to wait for JS rendering), `timeout` (ms before capture). Set `onlyMainContent=true` for article/focused content; increase `waitFor` and `timeout` for JS-heavy dynamic pages. |
| `sessionOptions` | object | No | Browser session configuration |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Session

**Slug:** `HYPERBROWSER_CREATE_SESSION`

Tool to create a new browser session with custom stealth, proxy, and privacy settings. Use when initializing an automated browsing session with specific configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `device` | array | No | Preferred device types |
| `screen` | object | No | Screen configuration: width and height in pixels. |
| `adblock` | boolean | No | Block ads in the session |
| `locales` | array | No | Browser locale codes (ISO 639-1 two-letter codes, e.g., 'en', 'fr', 'de', 'zh') |
| `profile` | object | No | Browser profile reuse settings. |
| `platform` | array | No | Preferred browser platforms |
| `trackers` | boolean | No | Block trackers during session |
| `useProxy` | boolean | No | Route session via a proxy server (requires paid plan) |
| `proxyCity` | string | No | Desired proxy city; mutually exclusive with proxyState |
| `annoyances` | boolean | No | Block common annoyances like pop-ups |
| `proxyState` | string | No | Two-letter US state code; mutually exclusive with proxyCity |
| `useStealth` | boolean | No | Enable stealth mode to reduce detection |
| `browserArgs` | array | No | Additional browser launch arguments |
| `proxyServer` | string | No | Proxy server host or URL |
| `extensionIds` | array | No | List of extension IDs (UUIDs) to attach |
| `proxyCountry` | string | No | Two-letter proxy country code (e.g., US, GB) |
| `urlBlocklist` | array | No | List of URL patterns to block |
| `acceptCookies` | boolean | No | Automatically accept cookie banners |
| `solveCaptchas` | boolean | No | Auto-solve CAPTCHAs during session (requires paid plan) |
| `timeoutMinutes` | integer | No | Auto-stop after N minutes (1-720) |
| `operatingSystems` | array | No | Preferred OS fingerprints |
| `enableWebRecording` | boolean | No | Enable rrweb session recording |
| `imageCaptchaParams` | array | No | Image CAPTCHA handling parameters |
| `proxyServerPassword` | string | No | Password for proxy authentication |
| `proxyServerUsername` | string | No | Username for proxy authentication |
| `enableVideoWebRecording` | boolean | No | Enable video recording; requires enableWebRecording=true |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Profile

**Slug:** `HYPERBROWSER_DELETE_PROFILE`

Tool to delete a profile. Use when you need to remove a profile by its unique identifier after confirming its existence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the profile to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Web Page

**Slug:** `HYPERBROWSER_FETCH_WEB_PAGE`

Tool to fetch a web page and return content in various formats (HTML, Markdown, JSON, screenshot, etc.). Use when you need to retrieve and process web content with customizable browser settings, output formats, and content filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Target URL to fetch |
| `cache` | object | No | Cache control options |
| `browser` | object | No | Browser configuration options |
| `outputs` | object | No | Output format and content filtering options |
| `stealth` | string ("none" | "auto" | "ultra") | No | Stealth mode level to avoid detection |
| `navigation` | object | No | Page navigation and loading options |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Browser Use Task Result

**Slug:** `HYPERBROWSER_GET_BROWSER_USE_TASK_RESULT`

DEPRECATED: Use HYPERBROWSER_GET_BROWSER_USE_TASK_STATUS instead. Tool to retrieve the status and results of a browser use task. Use after starting a browser use task to check its progress, retrieve execution steps, and obtain the final result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The jobId of the browser use task. This is the UUID returned when starting a browser use task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get browser-use task status

**Slug:** `HYPERBROWSER_GET_BROWSER_USE_TASK_STATUS`

Tool to retrieve the current status of a browser-use task. Use when checking if a browser automation task has completed or is still pending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Unique identifier of the browser-use task to query. This is the jobId returned when starting a browser-use task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Claude Computer Use Task Result

**Slug:** `HYPERBROWSER_GET_CLAUDE_COMPUTER_USE_TASK_RESULT`

Tool to retrieve the complete result and status of a Claude Computer Use task. Use when you need full task details including execution steps, final results, and error information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The jobId returned when starting a Claude Computer Use task via HYPERBROWSER_START_CLAUDE_COMPUTER_USE_TASK. This is a UUID format string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Claude Computer Use Task Status

**Slug:** `HYPERBROWSER_GET_CLAUDE_COMPUTER_USE_TASK_STATUS`

Poll the execution status of a Claude Computer Use task. Use after calling HYPERBROWSER_START_CLAUDE_COMPUTER_USE_TASK to check if the task has completed, is still running, or has failed. Pass the jobId returned from the start task action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The jobId returned when starting a Claude Computer Use task via HYPERBROWSER_START_CLAUDE_COMPUTER_USE_TASK. This is a UUID format string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crawl Job Status

**Slug:** `HYPERBROWSER_GET_CRAWL_JOB_STATUS`

Tool to retrieve the status and results of a specific crawl job. Use after submitting a crawl job to check its progress or fetch results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Crawl job identifier (UUID) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crawl Status

**Slug:** `HYPERBROWSER_GET_CRAWL_STATUS`

Tool to retrieve the current status of a specific crawl job. Use after initiating a crawl job to poll its status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the crawl job to retrieve status for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CUA Task Result

**Slug:** `HYPERBROWSER_GET_CUA_TASK_RESULT`

Tool to retrieve the status and results of a CUA (Claude User Agent) task. Use after starting a CUA task to check its progress, retrieve execution steps, and obtain the final result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The jobId of the CUA (Claude User Agent) task. This is the UUID returned when starting a CUA task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CUA Task Status

**Slug:** `HYPERBROWSER_GET_CUA_TASK_STATUS`

Poll the execution status of a CUA task. Use to check if a CUA task has completed, is still running, or has failed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the CUA task to query. This is a UUID format string returned when starting a CUA task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Extract Job Result

**Slug:** `HYPERBROWSER_GET_EXTRACT_JOB_RESULT`

Tool to fetch the status and results of a specific extract job. Use after initiating an extract job to monitor progress and retrieve final data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The UUID of the extract job returned by the Start Extract Job action |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Extract Job Status

**Slug:** `HYPERBROWSER_GET_EXTRACT_JOB_STATUS`

Retrieve the status of an extract job. Use after calling Start Extract Job to poll its progress. Poll periodically until status is 'completed' or 'failed', then use Get Extract Job Result to retrieve the extracted data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | UUID of the extract job returned by the Start Extract Job action (e.g., 'd0208f8c-0d1c-4697-bfc8-031f9bec20fc') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gemini Computer Use task result

**Slug:** `HYPERBROWSER_GET_GEMINI_COMPUTER_USE_TASK_RESULT`

Tool to retrieve the current status and results of a Gemini Computer Use task. Use when checking if a Gemini automation task has completed or is still pending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the Gemini Computer Use task to query. This is the jobId returned when starting a Gemini Computer Use task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get HyperAgent Task Result

**Slug:** `HYPERBROWSER_GET_HYPER_AGENT_TASK_RESULT`

Tool to retrieve the status and results of a HyperAgent task. Use when checking if a HyperAgent task has completed or to get the final results and execution steps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier (UUID) of the HyperAgent task. This is the jobId returned when starting a HyperAgent task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profile By ID

**Slug:** `HYPERBROWSER_GET_PROFILE`

Retrieves details of a specific Hyperbrowser profile by its UUID. Returns profile metadata including name, team association, and timestamps. Use the List Profiles action first to obtain valid profile IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (UUID) of the profile to retrieve. Get profile IDs from the List Profiles action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scrape Job Result

**Slug:** `HYPERBROWSER_GET_SCRAPE_JOB_RESULT`

Retrieves the status and results of a scrape job. Poll this endpoint after creating a scrape job to check progress and get the scraped content when completed. Returns jobId, status (pending/running/completed/failed), scraped data, and any error message.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the scrape job to retrieve (returned by create_scrape_job) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scrape Job Status

**Slug:** `HYPERBROWSER_GET_SCRAPE_JOB_STATUS`

Tool to retrieve the current status of a specific scrape job. Use after initiating a scrape job to poll its status; poll at moderate intervals (e.g., every 2–5 seconds) rather than tight loops to avoid exhausting quota. Responses may be large when the job includes screenshots or full HTML.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the scrape job to retrieve status for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Details

**Slug:** `HYPERBROWSER_GET_SESSION_DETAILS`

Retrieve detailed information about a Hyperbrowser session by its ID. Use this tool to get connection endpoints (wsEndpoint, liveUrl), session status, and configuration details for an existing session. The session ID can be obtained from create_session or list_sessions actions. Returns active connection details (wsEndpoint, liveUrl, token) for active sessions, or historical information for closed sessions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique session ID (UUID format) to retrieve details for. Obtain this from create_session or list_sessions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Downloads URL

**Slug:** `HYPERBROWSER_GET_SESSION_DOWNLOADS_URL`

Tool to retrieve the downloads URL for a session. Returns a signed URL to download files saved during a browser session. Note: The session must be created with 'saveDownloads: true' for downloads to be available. Poll this endpoint checking status until 'completed'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the session (must be a valid UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Recording

**Slug:** `HYPERBROWSER_GET_SESSION_RECORDING`

Retrieve the recording URL for a browser session. Returns a pre-signed S3 URL to download the rrweb JSON recording. The recording status indicates availability: - 'pending': Recording is being prepared - 'in_progress': Recording is still being processed - 'completed': Recording is ready, recordingUrl will contain the download link - 'failed': Recording failed, check the error field - 'not_enabled': Session was created without enableWebRecording=true Poll this endpoint until status is 'completed' or 'failed' after stopping a session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the session to retrieve recording for. Must be a valid UUID format (e.g., '550e8400-e29b-41d4-a716-446655440000'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Video Recording URL

**Slug:** `HYPERBROWSER_GET_SESSION_VIDEO_RECORDING_URL`

Tool to retrieve the video recording URL for a browser session. Returns a pre-signed URL to download the video recording. The video recording status indicates availability: - 'pending': Video recording is being prepared - 'in_progress': Video recording is still being processed - 'completed': Video recording is ready, recordingUrl will contain the download link - 'failed': Video recording failed, check the error field - 'not_enabled': Session was created without enableVideoWebRecording=true Poll this endpoint until status is 'completed' or 'failed' after stopping a session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the session to retrieve video recording for. Must be a valid UUID format (e.g., '21de56ee-8ba3-4b07-8e5b-bf0ac94445d1'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Web Crawl Result

**Slug:** `HYPERBROWSER_GET_WEB_CRAWL_RESULT`

Tool to retrieve the status and results of a web crawl job. Use after submitting a web crawl job to check its progress and fetch paginated results. Supports pagination via page and batchSize parameters for large crawl jobs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Web crawl job identifier (UUID) |
| `page` | integer | No | Page number for result pagination (1-indexed). Retrieves specific batch of results. |
| `batchSize` | integer | No | Number of items to return per page batch. Controls pagination size. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Web Crawl Status

**Slug:** `HYPERBROWSER_GET_WEB_CRAWL_STATUS`

Tool to retrieve just the status of a web crawl job without the full results. Use after initiating a web crawl to poll its current state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the web crawl job to retrieve status for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Extensions

**Slug:** `HYPERBROWSER_LIST_EXTENSIONS`

Tool to list all browser extensions. Use when you need to fetch all available extensions for the Hyperbrowser account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Profiles

**Slug:** `HYPERBROWSER_LIST_PROFILES`

Tool to list profiles. Use when you need to fetch paginated profiles and optionally filter by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter profiles by name containing this substring (case-insensitive) |
| `page` | integer | No | Page number to retrieve (1-based index) |
| `limit` | integer | No | Number of profiles to return per page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sessions

**Slug:** `HYPERBROWSER_LIST_SESSIONS`

Tool to list sessions with optional status filter. Use when you need a paginated overview of browser sessions before acting on them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default 1) |
| `status` | string ("active" | "closed" | "error") | No | Filter sessions by status |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Web

**Slug:** `HYPERBROWSER_SEARCH_WEB`

Tool to perform a web search and retrieve results with titles, URLs, and descriptions. Use when you need to search the web for information on a specific topic or query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for paginated results (starts at 1) |
| `query` | string | Yes | Search query string |
| `filters` | object | No | Advanced filters for refining search results. |
| `location` | object | No | Geographic location for localized search results. |
| `maxAgeSeconds` | integer | No | Maximum age of results in seconds (e.g., 86400 for last 24 hours) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Browser Use Task

**Slug:** `HYPERBROWSER_START_BROWSER_USE_TASK`

Tool to start an asynchronous browser-use task. Use when you need to automate web interactions given a task instruction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `llm` | string ("gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-4.1-mini" | "claude-sonnet-4-20250514" | "claude-3-7-sonnet-20250219" | "claude-3-5-sonnet-20241022" | "claude-3-5-haiku-20241022" | "gemini-2.0-flash") | No | Language model to drive the browser automation agent |
| `task` | string | Yes | Natural language description of what the AI agent should accomplish. Be specific and clear about the goal. |
| `apiKeys` | object | No | Custom API keys for providers |
| `maxSteps` | integer | No | Max agent steps before abort. Maximum allowed value depends on your Hyperbrowser plan (common plans cap at 25 steps) |
| `sessionId` | string | No | Reuse an existing browser session ID Useful for CAPTCHA-protected or bot-detection sites where a pre-authenticated or warmed-up session avoids re-triggering challenges. |
| `useVision` | boolean | No | Enable vision for page context |
| `plannerLlm` | string ("gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-4.1-mini" | "claude-sonnet-4-20250514" | "claude-3-7-sonnet-20250219" | "claude-3-5-sonnet-20241022" | "claude-3-5-haiku-20241022" | "gemini-2.0-flash") | No | LLM to use for planning |
| `maxFailures` | integer | No | Max failures allowed before abort |
| `initialActions` | array | No | Actions to run before starting the task |
| `maxInputTokens` | integer | No | Max input tokens allowed |
| `sessionOptions` | object | No | Browser session configuration |
| `validateOutput` | boolean | No | Whether to validate the final output |
| `keepBrowserOpen` | boolean | No | Keep the browser open after completion |
| `plannerInterval` | integer | No | Seconds between planner cycles |
| `useCustomApiKeys` | boolean | No | Use custom provider API keys |
| `maxActionsPerStep` | integer | No | Max actions per planning step |
| `pageExtractionLlm` | string ("gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-4.1-mini" | "claude-sonnet-4-20250514" | "claude-3-7-sonnet-20250219" | "claude-3-5-sonnet-20241022" | "claude-3-5-haiku-20241022" | "gemini-2.0-flash") | No | LLM to use for page extraction |
| `useVisionForPlanner` | boolean | No | Allow planner to use vision |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Claude Computer Use Task

**Slug:** `HYPERBROWSER_START_CLAUDE_COMPUTER_USE_TASK`

Tool to start a Claude Computer Use task. Use when you need AI-driven automated browser interactions. Call after you have your task prompt and any session preferences configured.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `llm` | string ("claude-sonnet-4-20250514" | "claude-3-7-sonnet-20250219") | No | Model variant to use for the task |
| `task` | string | Yes | Natural language instructions for the Claude agent |
| `apiKeys` | object | No | Custom API key configuration. |
| `maxSteps` | integer | No | Max action steps to run |
| `sessionId` | string | No | Reuse an existing session by ID |
| `maxFailures` | integer | No | Max allowed failures before abort |
| `sessionOptions` | object | No | Overrides for browsing session settings. |
| `keepBrowserOpen` | boolean | No | Keep browser open after completion |
| `useCustomApiKeys` | boolean | No | Whether to supply custom API keys |
| `useComputerAction` | boolean | No | Enable built-in Claude computer action library |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Crawl Job

**Slug:** `HYPERBROWSER_START_CRAWL_JOB`

Tool to start a new crawl job for a specified URL. Use when you need to initiate a web crawl before checking job status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Starting URL for the crawl job |
| `maxPages` | integer | No | Maximum pages to crawl (default: 10, max: 100) |
| `followLinks` | boolean | No | Whether to follow links during crawl |
| `ignoreSitemap` | boolean | No | Ignore sitemap.xml files if present |
| `scrapeOptions` | object | No | Configuration for post-crawl data extraction. |
| `sessionOptions` | object | No | Settings to configure the browser session during crawl. |
| `excludePatterns` | array | No | URL patterns to exclude from crawling |
| `includePatterns` | array | No | URL patterns to include in crawling |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start CUA Task

**Slug:** `HYPERBROWSER_START_CUA_TASK`

Tool to start an OpenAI CUA (Computer-Using Agent) task. Use when you need AI-driven automated browser interactions powered by OpenAI. Call after you have your task prompt and any session preferences configured.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task` | string | Yes | Natural language instructions for the OpenAI CUA agent |
| `apiKeys` | object | No | Custom API key configuration. |
| `maxSteps` | integer | No | Max action steps to run |
| `sessionId` | string | No | Reuse an existing session by ID |
| `maxFailures` | integer | No | Max allowed failures before abort |
| `sessionOptions` | object | No | Overrides for browsing session settings. |
| `keepBrowserOpen` | boolean | No | Keep browser open after completion |
| `useCustomApiKeys` | boolean | No | Whether to supply custom API keys |
| `useComputerAction` | boolean | No | Enable built-in computer action library |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Extract Job

**Slug:** `HYPERBROWSER_START_EXTRACT_JOB`

Start an AI-powered data extraction job from one or more web pages. Use this tool to scrape structured data from websites by providing URLs and either a natural language prompt describing what to extract, or a JSON schema defining the output structure (or both for best results). Returns a jobId to track extraction progress via HYPERBROWSER_GET_EXTRACT_JOB_STATUS and retrieve results via HYPERBROWSER_GET_EXTRACT_JOB_RESULT.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Yes | List of URLs to extract from (maximum 10 URLs per request); append /* to enable crawling the entire site |
| `prompt` | string | No | Natural language instructions describing what data to extract from the page(s). Either prompt or schema must be provided. |
| `schema` | object | No | JSON schema defining the structure of extracted data. Either prompt or schema must be provided. For best results, provide both. |
| `waitFor` | integer | No | Milliseconds to wait after page load before extraction |
| `maxLinks` | integer | No | Max links to consider when crawling (for URLs ending with /*) |
| `systemPrompt` | string | No | Optional system prompt to guide the extractor |
| `sessionOptions` | object | No | Browser/session configuration options |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Gemini Computer Use Task

**Slug:** `HYPERBROWSER_START_GEMINI_COMPUTER_USE_TASK`

Tool to start a Gemini Computer Use task for browser automation using Google's Gemini. Use when you need AI-driven automated browser interactions with Gemini models.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `llm` | string | No | Model variant to use for the task |
| `task` | string | Yes | Natural language instructions for the Gemini agent |
| `apiKeys` | object | No | Custom API key configuration. |
| `maxSteps` | integer | No | Max action steps to run |
| `sessionId` | string | No | Reuse an existing session by ID |
| `maxFailures` | integer | No | Max allowed failures before abort |
| `sessionOptions` | object | No | Overrides for browsing session settings. |
| `keepBrowserOpen` | boolean | No | Keep browser open after completion |
| `useCustomApiKeys` | boolean | No | Whether to supply custom API keys |
| `useComputerAction` | boolean | No | Enable built-in Gemini computer action library |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Web Crawl

**Slug:** `HYPERBROWSER_START_WEB_CRAWL`

Tool to start an asynchronous web crawl job that follows links from a starting URL and returns content from each page. Use when you need to crawl multiple pages from a website.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Starting URL for the web crawl |
| `cache` | object | No | Caching configuration for crawl results. |
| `browser` | object | No | Browser configuration options. |
| `outputs` | object | No | Configuration for content extraction and output. |
| `stealth` | string ("none" | "auto" | "ultra") | No | Stealth mode options for browser fingerprinting. |
| `navigation` | object | No | Navigation timing and wait configuration. |
| `crawlOptions` | object | No | Options for controlling the web crawl behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Browser Use Task

**Slug:** `HYPERBROWSER_STOP_BROWSER_USE_TASK`

Tool to stop a running browser-use task. Use when halting an in-progress browser automation task after confirming its task ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the browser-use task to stop |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Claude Computer Use Task

**Slug:** `HYPERBROWSER_STOP_CLAUDE_COMPUTER_USE_TASK`

Tool to stop a running Claude computer use task. Use when a Claude computer use task is in progress and needs to be terminated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (jobId) of the Claude computer use task to stop. This ID is returned when starting a task via the Start Claude Computer Use Task action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop CUA Task

**Slug:** `HYPERBROWSER_STOP_CUA_TASK`

Tool to stop a running CUA task. Use when a CUA task is in progress and needs to be terminated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the CUA task to stop. This ID is returned when starting a CUA task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Gemini Computer Use Task

**Slug:** `HYPERBROWSER_STOP_GEMINI_COMPUTER_USE_TASK`

Tool to stop a running Gemini computer use task. Use when a Gemini computer use task is in progress and needs to be terminated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (jobId) of the Gemini computer use task to stop. This ID is returned when starting a task via the Start Gemini Computer Use Task action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Session

**Slug:** `HYPERBROWSER_STOP_SESSION`

Tool to stop a running session by ID. Use after confirming the session is active.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the session to stop |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |