OpenAI CUA

Start a CUA task

post
Authorizations
Body
taskstringRequired
sessionIdstringOptional
maxFailuresnumberOptionalDefault: 3
maxStepsnumberOptionalDefault: 20
keepBrowserOpenbooleanOptionalDefault: false
Responses
200
CUA task started successfully
application/json
post
POST /api/task/cua HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 803

{
  "task": "text",
  "sessionId": "text",
  "maxFailures": 3,
  "maxSteps": 20,
  "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 CUA task status and results

get
Authorizations
Path parameters
idstringRequired
Responses
200
CUA task details
application/json
get
GET /api/task/cua/{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 CUA task

put
Authorizations
Path parameters
idstringRequired
Responses
200
CUA task stopped successfully
application/json
put
PUT /api/task/cua/{id}/stop HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
200

CUA task stopped successfully

{
  "success": true
}

Get CUA task status

get
Authorizations
Path parameters
idstringRequired
Responses
200
CUA task status
application/json
get
GET /api/task/cua/{id}/status HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
  "status": "pending"
}

Last updated