Extract | Hyperbrowser

Start an extract job

post

Authorizations

Body

urlsstring[]Required

systemPromptstringOptional

maxLinksnumberOptional

promptstringOptional

schemaobjectOptional

waitFornumberOptionalDefault: 0

Responses

200

Extract job started successfully

application/json

400

Invalid request parameters

application/json

500

Server error

application/json

post

POST /api/extract HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 807

{
  "urls": [
    "text"
  ],
  "systemPrompt": "text",
  "maxLinks": 1,
  "prompt": "text",
  "schema": {},
  "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
  },
  "waitFor": 0
}

{
  "jobId": "text"
}

Get extract job status

get

Authorizations

Path parameters

idstring · uuidRequired

Responses

200

Extract job status

application/json

404

Extract job not found

application/json

500

Server error

application/json

get

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

{
  "status": "pending"
}

Get extract job status and results

get

Authorizations

Path parameters

idstringRequired

Responses

200

Extract job details

application/json

404

Extract job not found

application/json

500

Server error

application/json

get

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

{
  "jobId": "text",
  "status": "pending",
  "data": {},
  "error": "text"
}