Skip to main content
POST
/
api
/
task
/
browser-use
JavaScript
import { Hyperbrowser } from '@hyperbrowser/sdk';

const client = new Hyperbrowser({ apiKey: 'your-api-key' });

await client.agents.browserUse.start({
  task: 'Find the price of the product',
  llm: 'gemini-2.0-flash',
  maxSteps: 20
});
{
  "jobId": "<string>",
  "liveUrl": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
task
string
required
llm
enum<string>
default:gemini-2.0-flash
Available options:
gpt-4o,
gpt-4o-mini,
gpt-4.1,
gpt-4.1-mini,
claude-sonnet-4-5,
claude-sonnet-4-20250514,
claude-3-7-sonnet-20250219,
claude-3-5-sonnet-20241022,
claude-3-5-haiku-20241022,
gemini-2.0-flash,
gemini-2.5-flash
sessionId
string
validateOutput
boolean
default:false
useVision
boolean
default:true
useVisionForPlanner
boolean
default:false
maxActionsPerStep
number
default:10
maxInputTokens
number
default:128000
plannerLlm
enum<string>
default:gemini-2.0-flash
Available options:
gpt-4o,
gpt-4o-mini,
gpt-4.1,
gpt-4.1-mini,
claude-sonnet-4-5,
claude-sonnet-4-20250514,
claude-3-7-sonnet-20250219,
claude-3-5-sonnet-20241022,
claude-3-5-haiku-20241022,
gemini-2.0-flash,
gemini-2.5-flash
pageExtractionLlm
enum<string>
default:gemini-2.0-flash
Available options:
gpt-4o,
gpt-4o-mini,
gpt-4.1,
gpt-4.1-mini,
claude-sonnet-4-5,
claude-sonnet-4-20250514,
claude-3-7-sonnet-20250219,
claude-3-5-sonnet-20241022,
claude-3-5-haiku-20241022,
gemini-2.0-flash,
gemini-2.5-flash
plannerInterval
number
default:10
maxSteps
number
default:20
maxFailures
number
default:3
initialActions
object[]
sensitiveData
object
messageContext
string
keepBrowserOpen
boolean
default:false
sessionOptions
object
useCustomApiKeys
boolean
default:false
apiKeys
object

Response

Browser use task started successfully

jobId
string
required
liveUrl
string | null