Skip to main content
GET
/
api
/
crawl
/
{id}
JavaScript
import { Hyperbrowser } from '@hyperbrowser/sdk';

const client = new Hyperbrowser({ apiKey: 'your-api-key' });

await client.crawl.get('job-id', {
  page: 1
});
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": "<string>",
  "totalCrawledPages": 1,
  "totalPageBatches": 1,
  "currentPageBatch": 1,
  "batchSize": 2,
  "data": [
    {
      "url": "<string>",
      "error": "<string>",
      "metadata": {},
      "markdown": "<string>",
      "html": "<string>",
      "links": [
        "<string>"
      ],
      "screenshot": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Query Parameters

​
page
integer
Required range: x >= 0
​
batchSize
integer
Required range: x >= 1

Response

Crawl job details retrieved successfully

​
jobId
string<uuid>
required
​
status
enum<string>
required
Available options:
pending,
running,
completed,
failed,
stopped
​
error
string | null
​
totalCrawledPages
integer
Required range: x >= 0
​
totalPageBatches
integer
Required range: x >= 0
​
currentPageBatch
integer
Required range: x >= 0
​
batchSize
integer
Required range: x >= 1
​
data
object[]