Browser Use | Hyperbrowser

Start a browser use task

post

Authorizations

Body

taskstringRequired

llmstring · enumOptionalDefault: gemini-2.0-flashPossible values:

sessionIdstringOptional

validateOutputbooleanOptionalDefault: false

useVisionbooleanOptionalDefault: true

useVisionForPlannerbooleanOptionalDefault: false

maxActionsPerStepnumberOptionalDefault: 10

maxInputTokensnumberOptionalDefault: 128000

plannerLlmstring · enumOptionalDefault: gemini-2.0-flashPossible values:

pageExtractionLlmstring · enumOptionalDefault: gemini-2.0-flashPossible values:

plannerIntervalnumberOptionalDefault: 10

maxStepsnumberOptionalDefault: 20

maxFailuresnumberOptionalDefault: 3

keepBrowserOpenbooleanOptionalDefault: false

Responses

200

Browser use task started successfully

application/json

500

Server error

application/json

post

POST /api/task/browser-use HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1121

{
  "task": "text",
  "llm": "gemini-2.0-flash",
  "sessionId": "text",
  "validateOutput": false,
  "useVision": true,
  "useVisionForPlanner": false,
  "maxActionsPerStep": 10,
  "maxInputTokens": 128000,
  "plannerLlm": "gemini-2.0-flash",
  "pageExtractionLlm": "gemini-2.0-flash",
  "plannerInterval": 10,
  "maxSteps": 20,
  "maxFailures": 3,
  "initialActions": [
    {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "keepBrowserOpen": false,
  "sessionOptions": {
    "useStealth": false,
    "useProxy": false,
    "proxyServer": "text",
    "proxyServerPassword": "text",
    "proxyServerUsername": "text",
    "proxyCountry": "AD",
    "proxyState": "AL",
    "proxyCity": "new york",
    "operatingSystems": [
      "windows"
    ],
    "device": [
      "desktop"
    ],
    "platform": [
      "chrome"
    ],
    "locales": [
      "aa"
    ],
    "screen": {
      "width": 1280,
      "height": 720
    },
    "solveCaptchas": false,
    "adblock": false,
    "trackers": false,
    "annoyances": false,
    "enableWebRecording": true,
    "enableVideoWebRecording": false,
    "profile": {
      "id": "text",
      "persistChanges": true
    },
    "acceptCookies": true,
    "extensionIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "urlBlocklist": [
      "text"
    ],
    "browserArgs": [
      "text"
    ],
    "imageCaptchaParams": [
      {
        "imageSelector": "text",
        "inputSelector": "text"
      }
    ],
    "timeoutMinutes": 1
  }
}

{
  "jobId": "text",
  "liveUrl": "text"
}

Get browser use task status and results

get

Authorizations

Path parameters

idstringRequired

Responses

200

Browser use task details

application/json

404

Browser use task not found

application/json

500

Server error

application/json

get

GET /api/task/browser-use/{id} HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "jobId": "text",
  "status": "pending",
  "data": {
    "steps": [
      {}
    ],
    "finalResult": "text"
  },
  "error": "text",
  "liveUrl": "text"
}

Stop a browser use task

put

Authorizations

Path parameters

idstringRequired

Responses

200

Browser use task stopped successfully

application/json

put

PUT /api/task/browser-use/{id}/stop HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

200

Browser use task stopped successfully

{
  "success": true
}

Get browser use task status

get

Authorizations

Path parameters

idstringRequired

Responses

200

Browser use task status

application/json

404

Browser use task not found

application/json

500

Server error

application/json

get

GET /api/task/browser-use/{id}/status HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "status": "pending"
}