Extract

Last updated 1 month ago

Start an extract job

post

/api/extract

Authorizations

Body

systemPromptstring

maxLinksnumber

promptstring

schemaobject

sessionOptionsobject

urlsstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.hyperbrowser.ai/api/extract' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "systemPrompt": "text",
    "maxLinks": 1,
    "prompt": "text",
    "schema": {},
    "sessionOptions": {
      "useStealth": false,
      "useProxy": false,
      "proxyServer": "text",
      "proxyServerPassword": "text",
      "proxyServerUsername": "text",
      "proxyCity": "new york",
      "solveCaptchas": false,
      "adblock": false,
      "trackers": false,
      "annoyances": false,
      "enableWebRecording": true,
      "profile": {
        "id": "text",
        "persistChanges": true
      },
      "acceptCookies": true,
      "proxyCountry": "US",
      "proxyState": "AL",
      "extensionIds": [],
      "urlBlocklist": [],
      "browserArgs": [],
      "operatingSystems": [
        "windows"
      ],
      "device": [
        "desktop"
      ],
      "platform": [
        "chrome"
      ],
      "locales": [
        "en"
      ],
      "screen": {
        "width": 1280,
        "height": 720
      }
    },
    "urls": [
      "text"
    ]
  }'

200

400

500

{
  "jobId": "text"
}

Extract job started successfully

Get extract job status and results

get

/api/extract/{id}