How It Works
You can use CUA 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
Quick Start
The simplest way to run a CUA task is with thestartAndWait() method, which handles everything for you:
Async Pattern
When you need more control, use the async pattern to start a task and poll for results:Stop a Running Task
Stop a task before it completes:Parameters
Natural language description of what you want CUA to accomplish. Be specific for best results.
Maximum number of actions CUA can take (clicks, typing, navigation, etc.). Increase for complex tasks.
Maximum consecutive failures before the task is aborted.
ID of an existing browser session to reuse. Useful for multi-step workflows that need to maintain the same browser session.
Keep the browser session alive after task completion.
Allow the agent to interact by executing actions on the actual computer not just within the page. Allows the agent to see the entire screen instead of just the page contents.
Session configuration (proxy, stealth, captcha solving, etc.). Only applies when creating a new session. If you provide an existing 
sessionId, these options are ignored.Use your own OpenAI API key instead of consuming Hyperbrowser credits for LLM calls. You will only be charged for browser usage.
API key for 
openai. Required when useCustomApiKeys is true.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.useComputerAction can often be better for completing tasks but may require more steps. It is especially useful when the agent needs to interact with elements on the page that might not be accessible by or visible to Playwright. Since it allows the agent to see and interact with the entire screen, it is much more powerful. Instead of executing actions with Playwright which can only interact with the page via CDP, computer actions allow the agent to interact directly with computer primitives (direct clicks, typing, scroll, etc.).Reuse Browser Sessions
You can pass in an existingsessionId to the CUA 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.
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 OpenAI API key to avoid consuming Hyperbrowser credits for LLM calls. You’ll still be charged for browser session usage, but save on token costs.Session Configuration
Customize the browser session used by CUA with session options.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
Write clear, specific task descriptions
Be explicit about what you want CUA 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
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
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.