Scrape

Create new scrape job

POSThttps://app.hyperbrowser.ai/api/scrape

Authorization

ApiKeyAuth

Body

application/json

url*string

sessionOptionsCreateSessionParams (object)

scrapeOptionsScrapeOptions (object)

Response

200400500

Scrape job created

Body

application/json

jobIdstring (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://app.hyperbrowser.ai/api/scrape', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

200400500

{
  "jobId": "123e4567-e89b-12d3-a456-426614174000"
}

Get scrape job status and result

GEThttps://app.hyperbrowser.ai/api/scrape/{id}

Authorization

ApiKeyAuth

Path parameters

id*string (uuid)

Response

200404500

Scrape job details

Body

application/json

jobId*string (uuid)

status*enum

pendingrunningcompletedfailed

errornullable string

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://app.hyperbrowser.ai/api/scrape/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404500

{
  "jobId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "error": "text",
  "data": {
    "markdown": "text",
    "html": "text",
    "links": [
      "text"
    ]
  }
}