HyperAgent

This page covers running HyperAgent via the Hyperbrowser Cloud API. For using the HyperAgent SDK directly in your own code (local or self-hosted), see the HyperAgent SDK documentation.

HyperAgent is our open-source tool that supercharges Playwright with AI. To view the full details on HyperAgent, check out the HyperAgent Github Repo. Here, we will just go over using one of the features of HyperAgent which is being able to have it automatically execute tasks on your behalf on the web with just a simple call. By default, HyperAgent tasks are handled in an asynchronous manner of first starting the task and then checking its status until it is completed. However, if you don’t want to handle the monitoring yourself, our SDKs provide a simple function that handles the whole flow and returns the data once the task is completed. You can view your HyperAgent tasks in the dashboard.

How It Works

You can use HyperAgent in two ways:

Start and Wait: SDKs provide a startAndWait() method that blocks until the task completes and returns the result
Async Pattern: Start a task, get a job ID, then poll for status and results—useful for long-running tasks or when you want more control

Installation

npm install @hyperbrowser/sdk dotenv

yarn add @hyperbrowser/sdk dotenv

pip install hyperbrowser python-dotenv

uv add hyperbrowser python-dotenv

Quick Start

The simplest way to run a HyperAgent task is with the startAndWait() method, which handles everything for you:

import { Hyperbrowser } from "@hyperbrowser/sdk";
import { config } from "dotenv";

config();

const client = new Hyperbrowser({
  apiKey: process.env.HYPERBROWSER_API_KEY,
});

async function main() {
  const result = await client.agents.hyperAgent.startAndWait({
    version: "1.1.0",
    task: "Go to Hacker News and tell me the title of the top post",
    llm: "gemini-3-flash-preview",
    maxSteps: 20,
  });

  console.log(`Output:\n${result.data?.finalResult}`);
}

main().catch((err) => {
  console.error(`Error: ${err.message}`);
});

from hyperbrowser import Hyperbrowser
import os
from dotenv import load_dotenv

load_dotenv()

client = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))

result = client.agents.hyper_agent.start_and_wait(
    params={
        "version": "1.1.0",
        "task": "Go to Hacker News and tell me the title of the top post",
        "llm": "gemini-3-flash-preview",
        "max_steps": 20,
    }
)

print(f"Output:\n{result.data.final_result}")

from hyperbrowser import Hyperbrowser
from hyperbrowser.models import StartHyperAgentTaskParams
import os
from dotenv import load_dotenv

load_dotenv()

client = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))

result = client.agents.hyper_agent.start_and_wait(
    params=StartHyperAgentTaskParams(
        version="1.1.0",
        task="Go to Hacker News and tell me the title of the top post",
        llm="gemini-3-flash-preview",
        max_steps=20,
    )
)

print(f"Output:\n{result.data.final_result}")

# Start the task
curl -X POST https://api.hyperbrowser.ai/api/task/hyper-agent \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "task": "Go to Hacker News and tell me the title of the top post",
    "llm": "gpt-4o",
    "maxSteps": 20
  }'

# Response: {"jobId": "abc123", "liveUrl": "https://..."}

# Check status
curl https://api.hyperbrowser.ai/api/task/hyper-agent/abc123/status \
  -H "x-api-key: YOUR_API_KEY"

# Get full results
curl https://api.hyperbrowser.ai/api/task/hyper-agent/abc123 \
  -H "x-api-key: YOUR_API_KEY"

Async Pattern

When you need more control, use the async pattern to start a task and poll for results:

import { Hyperbrowser } from "@hyperbrowser/sdk";
import { config } from "dotenv";

config();

const client = new Hyperbrowser({
  apiKey: process.env.HYPERBROWSER_API_KEY,
});

async function main() {
  try {
    // Start the task
    const task = await client.agents.hyperAgent.start({
      version: "1.1.0",
      task: "What is the title of the first post on Hacker News today?",
      llm: "gemini-3-flash-preview",
      maxSteps: 20,
    });

    console.log(`Task started: ${task.jobId}`);
    console.log(`Watch live: ${task.liveUrl}`);

    // Poll for completion
    let result;
    while (true) {
      result = await client.agents.hyperAgent.getStatus(task.jobId);
      console.log(`Status: ${result.status}`);

      if (result.status === "completed" || result.status === "failed") {
        break;
      }

      await new Promise((resolve) => setTimeout(resolve, 5000)); // Wait 5s
    }

    const fullResult = await client.agents.hyperAgent.get(task.jobId);

    if (fullResult.status === "completed") {
      console.log("Result:", fullResult.data?.finalResult);
      console.log("Steps taken:", fullResult.data?.steps?.length);
    } else {
      console.error("Task failed:", fullResult.error);
    }
  } catch (err) {
    console.error(`Error: ${err.message}`);
  }
}

main();

import asyncio
from hyperbrowser import AsyncHyperbrowser
from dotenv import load_dotenv
import os

load_dotenv()

client = AsyncHyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))


async def main():
    try:
        # Start the task
        task = await client.agents.hyper_agent.start(
            params={
                "version": "1.1.0",
                "task": "What is the title of the first post on Hacker News today?",
                "llm": "gemini-3-flash-preview",
                "max_steps": 20,
            }
        )

        print(f"Task started: {task.job_id}")
        print(f"Watch live: {task.live_url}")

        # Poll for completion
        while True:
            result = await client.agents.hyper_agent.get_status(task.job_id)
            print(f"Status: {result.status}")

            if result.status in ["completed", "failed"]:
                break

            await asyncio.sleep(5)  # Wait 5s

        full_result = await client.agents.hyper_agent.get(task.job_id)

        if full_result.status == "completed":
            print("Result:", full_result.data.final_result)
            print(
                "Steps taken:",
                len(full_result.data.steps) if full_result.data.steps else 0,
            )
        else:
            print("Task failed:", full_result.error)
    except Exception as e:
        print(f"Error: {e}")


if __name__ == "__main__":
    asyncio.run(main())

import asyncio
from hyperbrowser import AsyncHyperbrowser
from hyperbrowser.models import StartHyperAgentTaskParams
from dotenv import load_dotenv
import os

load_dotenv()

client = AsyncHyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))


async def main():
    try:
        # Start the task
        task = await client.agents.hyper_agent.start(
            params=StartHyperAgentTaskParams(
                version="1.1.0",
                task="What is the title of the first post on Hacker News today?",
                llm="gemini-3-flash-preview",
                max_steps=20,
            )
        )

        print(f"Task started: {task.job_id}")
        print(f"Watch live: {task.live_url}")

        # Poll for completion
        while True:
            result = await client.agents.hyper_agent.get_status(task.job_id)
            print(f"Status: {result.status}")

            if result.status in ["completed", "failed"]:
                break

            await asyncio.sleep(5)  # Wait 5s

        full_result = await client.agents.hyper_agent.get(task.job_id)

        if full_result.status == "completed":
            print("Result:", full_result.data.final_result)
            print(
                "Steps taken:",
                len(full_result.data.steps) if full_result.data.steps else 0,
            )
        else:
            print("Task failed:", full_result.error)
    except Exception as e:
        print(f"Error: {e}")


if __name__ == "__main__":
    asyncio.run(main())

Stop a Running Task

Stop a task before it completes:

await client.agents.hyperAgent.stop("job-id");

client.agents.hyper_agent.stop("job-id")

curl -X PUT https://api.hyperbrowser.ai/api/task/hyper-agent/job-id/stop \
  -H "x-api-key: YOUR_API_KEY"

Parameters

string

required

Natural language description of what you want HyperAgent to accomplish. Be specific for best results.

string

default:"0.8.0"

Version of HyperAgent to use. Options: 0.8.0, 1.1.0

We highly recommend using the 1.1.0 version of HyperAgent.

string

default:"gpt-4o"

LLM model to use. Available options:

"gpt-5.6-luna" - GPT-5.6 Luna
"gpt-5.5" - GPT-5.5
"gpt-5.2" - GPT-5.2
"gpt-5.1" - GPT-5.1
"gpt-5" - GPT-5
"gpt-5-mini" - GPT-5 Mini
"gpt-4o" - GPT-4o (default)
"gpt-4o-mini" - GPT-4o Mini
"gpt-4.1" - GPT-4.1
"gpt-4.1-mini" - GPT-4.1 Mini
"claude-sonnet-5" - Claude Sonnet 5
"claude-sonnet-4-6" - Claude Sonnet 4.6
"claude-sonnet-4-5" - Claude Sonnet 4.5
"gemini-3-flash-preview" - Gemini 2.5 Flash
"gemini-3-flash-preview" - Gemini 3 Flash Preview

Claude and Gemini models are not supported on the 0.8.0 version of HyperAgent.

number

default:"20"

Maximum number of actions HyperAgent can take (clicks, typing, navigation, etc.). Increase for complex tasks.

string

ID of an existing browser session to reuse. Useful for multi-step workflows that need to maintain the same browser session.

boolean

default:"false"

Keep the browser session alive after task completion.

object

Session configuration (proxy, stealth, captcha solving, etc.). Only applies when creating a new session. If you provide an existing sessionId, these options are ignored.

boolean

default:"false"

Use your own LLM API keys instead of consuming Hyperbrowser credits for LLM calls. You will only be charged for browser usage.

object

API keys for openai, anthropic, and google. Required when useCustomApiKeys is true. Must provide keys based on the LLM you are using.

{
  openai: "...",
  anthropic: "...",
  google: "..."
}

The agent may not complete the task within the specified maxSteps. If that happens, try increasing the maxSteps parameter.Additionally, the browser session used by the AI Agent will time out based on your team’s default Session Timeout settings or the session’s timeoutMinutes parameter if provided. You can adjust the default Session Timeout in the Settings page.

Reuse Browser Sessions

You can pass in an existing sessionId to the HyperAgent task so that it can execute the task on an existing session. Also, if you want to keep the session open after executing the task, you can supply the keepBrowserOpen parameter.

import { Hyperbrowser } from "@hyperbrowser/sdk";
import { config } from "dotenv";

config();

const client = new Hyperbrowser({
  apiKey: process.env.HYPERBROWSER_API_KEY,
});

const main = async () => {
  const session = await client.sessions.create();

  try {
    const result = await client.agents.hyperAgent.startAndWait({
      version: "1.1.0",
      task: "What is the title of the first post on Hacker News today?",
      llm: "gemini-3-flash-preview",
      sessionId: session.id,
      keepBrowserOpen: true,
    });

    console.log(`Output:\n${result.data?.finalResult}`);

    const result2 = await client.agents.hyperAgent.startAndWait({
      version: "1.1.0",
      llm: "gemini-3-flash-preview",
      task: "Tell me how many upvotes the first post has.",
      sessionId: session.id,
    });

    console.log(`\nOutput:\n${result2.data?.finalResult}`);
  } catch (err) {
    console.error(`Error: ${err}`);
  } finally {
    await client.sessions.stop(session.id);
  }
};

main().catch((err) => {
  console.error(`Error: ${err.message}`);
});

import os
from hyperbrowser import Hyperbrowser
from dotenv import load_dotenv

load_dotenv()

client = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))


def main():
    session = client.sessions.create()

    try:
        resp = client.agents.hyper_agent.start_and_wait(
            {
                "version": "1.1.0",
                "task": "What is the title of the first post on Hacker News today?",
                "llm": "gemini-3-flash-preview",
                "session_id": session.id,
                "keep_browser_open": True,
            }
        )

        print(f"Output:\n{resp.data.final_result}")

        resp2 = client.agents.hyper_agent.start_and_wait(
            {
                "version": "1.1.0",
                "llm": "gemini-3-flash-preview",
                "task": "Tell me how many upvotes the first post has.",
                "session_id": session.id,
            }
        )

        print(f"\nOutput:\n{resp2.data.final_result}")
    except Exception as e:
        print(f"Error: {e}")
    finally:
        client.sessions.stop(session.id)


if __name__ == "__main__":
    try:
        main()
    except Exception as e:
        print(f"Error: {e}")

import os
from hyperbrowser import Hyperbrowser
from hyperbrowser.models import StartHyperAgentTaskParams
from dotenv import load_dotenv

load_dotenv()

client = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))


def main():
    session = client.sessions.create()

    try:
        resp = client.agents.hyper_agent.start_and_wait(
            StartHyperAgentTaskParams(
                version="1.1.0",
                task="What is the title of the first post on Hacker News today?",
                llm="gemini-3-flash-preview",
                session_id=session.id,
                keep_browser_open=True,
            )
        )

        print(f"Output:\n{resp.data.final_result}")

        resp2 = client.agents.hyper_agent.start_and_wait(
            StartHyperAgentTaskParams(
                version="1.1.0",
                llm="gemini-3-flash-preview",
                task="Tell me how many upvotes the first post has.",
                session_id=session.id,
            )
        )

        print(f"\nOutput:\n{resp2.data.final_result}")
    except Exception as e:
        print(f"Error: {e}")
    finally:
        client.sessions.stop(session.id)


if __name__ == "__main__":
    try:
        main()
    except Exception as e:
        print(f"Error: {e}")

Always set keepBrowserOpen: true on tasks that you want to reuse the session from. Otherwise, the session will be automatically closed when the task completes.

Using Your Own API Keys

Bring your own LLM API keys to avoid consuming Hyperbrowser credits for LLM calls. You’ll still be charged for browser session usage, but save on token costs.

import { Hyperbrowser } from "@hyperbrowser/sdk";
import { config } from "dotenv";

config();

const client = new Hyperbrowser({
  apiKey: process.env.HYPERBROWSER_API_KEY,
});

const main = async () => {
  const result = await client.agents.hyperAgent.startAndWait({
    version: "1.1.0",
    task: "What is the title of the first post on Hacker News today?",
    llm: "gpt-5.2",
    useCustomApiKeys: true,
    apiKeys: {
      openai: "<OPENAI_API_KEY>",
    },
  });

  console.log(`Output:\n\n${result.data?.finalResult}`);
};

main().catch((err) => {
  console.error(`Error: ${err.message}`);
});

import os
from hyperbrowser import Hyperbrowser
from dotenv import load_dotenv

load_dotenv()

client = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))


def main():
    resp = client.agents.hyper_agent.start_and_wait(
        {
            "version": "1.1.0",
            "task": "What is the title of the first post on HackerNews today?",
            "llm": "gpt-5.2",
            "use_custom_api_keys": True,
            "api_keys": {
                "openai": "<OPENAI_API_KEY>",
            },
        }
    )

    print(f"Output:\n\n{resp.data.final_result}")


if __name__ == "__main__":
    try:
        main()
    except Exception as e:
        print(f"Error: {e}")

import os
from hyperbrowser import Hyperbrowser
from hyperbrowser.models import StartHyperAgentTaskParams, HyperAgentApiKeys
from dotenv import load_dotenv

load_dotenv()

client = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))


def main():
    resp = client.agents.hyper_agent.start_and_wait(
        StartHyperAgentTaskParams(
            version="1.1.0",
            task="What is the title of the first post on HackerNews today?",
            llm="gpt-5.2",
            use_custom_api_keys=True,
            api_keys=HyperAgentApiKeys(
                openai="<OPENAI_API_KEY>",
            ),
        )
    )

    print(f"Output:\n\n{resp.data.final_result}")


if __name__ == "__main__":
    try:
        main()
    except Exception as e:
        print(f"Error: {e}")

curl -X POST https://api.hyperbrowser.ai/api/task/hyper-agent \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_HYPERBROWSER_API_KEY" \
  -d '{
    "task": "What is the title of the first post on Hacker News today?",
    "llm": "gpt-4o",
    "useCustomApiKeys": true,
    "apiKeys": {
      "openai": "YOUR_OPENAI_API_KEY"
    }
  }'

Session Configuration

Customize the browser session used by HyperAgent with session options.

import { Hyperbrowser } from "@hyperbrowser/sdk";
import { config } from "dotenv";

config();

const client = new Hyperbrowser({
  apiKey: process.env.HYPERBROWSER_API_KEY,
});

const main = async () => {
  const result = await client.agents.hyperAgent.startAndWait({
    version: "1.1.0",
    task: "What is the title of the first post on Hacker News today?",
    llm: "gemini-3-flash-preview",
    sessionOptions: {
      acceptCookies: true,
    }
  });

  console.log(`Output:\n\n${result.data?.finalResult}`);
};

main().catch((err) => {
  console.error(`Error: ${err.message}`);
});

import os
from hyperbrowser import Hyperbrowser
from dotenv import load_dotenv

load_dotenv()

client = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))


def main():
    resp = client.agents.hyper_agent.start_and_wait(
        {
            "version": "1.1.0",
            "task": "What is the title of the first post on Hacker News today?",
            "llm": "gemini-3-flash-preview",
            "session_options": {
                "accept_cookies": True,
            },
        }
    )

    print(f"Output:\n\n{resp.data.final_result}")


if __name__ == "__main__":
    try:
        main()
    except Exception as e:
        print(f"Error: {e}")

import os
from hyperbrowser import Hyperbrowser
from hyperbrowser.models import StartHyperAgentTaskParams, CreateSessionParams
from dotenv import load_dotenv

load_dotenv()

client = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))


def main():
    resp = client.agents.hyper_agent.start_and_wait(
        StartHyperAgentTaskParams(
            version="1.1.0",
            task="What is the title of the first post on Hacker News today?",
            llm="gemini-3-flash-preview",
            session_options=CreateSessionParams(
                accept_cookies=True,
            ),
        )
    )

    print(f"Output:\n\n{resp.data.final_result}")


if __name__ == "__main__":
    try:
        main()
    except Exception as e:
        print(f"Error: {e}")

curl -X POST https://api.hyperbrowser.ai/api/task/hyper-agent \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: <YOUR_API_KEY>' \
  -d '{
      "task": "What is the title of the first post on Hacker News today?",
      "llm": "gpt-4o",
      "sessionOptions": {
          "acceptCookies": true
      }
  }'

sessionOptions only applies when creating a new session. If you provide a sessionId, these options are ignored.

Proxies and CAPTCHA solving add latency to page navigation. Only enable them when necessary for your use case.

Best Practices

Write clear, specific task descriptions

Be explicit about what you want HyperAgent to do. Instead of “check the website”, say “go to example.com, find the pricing page, and extract the cost of the Enterprise plan”.

Set appropriate maxSteps

Simple tasks need 10-20 steps. Complex multi-page workflows might need 50+ steps. Monitor failed tasks and adjust accordingly.

Reuse sessions for multi-step workflows

It is usually better to split up complex tasks into smaller, more manageable ones and execute them as separate agent calls on the same session.

Get Started

Browser Sessions

Session Configuration

Web API

Agents

HyperAgent Usage

Scraping

Integrations

How It Works

Installation

Quick Start

Async Pattern

Stop a Running Task

Parameters

Reuse Browser Sessions

Using Your Own API Keys

Session Configuration

Best Practices

​How It Works

​Installation

​Quick Start

​Async Pattern

​Stop a Running Task

​Parameters

​Reuse Browser Sessions

​Using Your Own API Keys

​Session Configuration

​Best Practices

How It Works

Installation

Quick Start

Async Pattern

Stop a Running Task

Parameters

Reuse Browser Sessions

Using Your Own API Keys

Session Configuration

Best Practices