Hyperbrowser home page
Search...
Dashboard
Support
Dashboard
Search...
Navigation
API Reference
Start a crawl job
Documentation
API Reference
Documentation
Community
API Documentation
Introduction
API Reference
POST
Create new session
GET
Get session by ID
PUT
Stop a session
GET
Get list of sessions
POST
Create new scrape job
GET
Get scrape job status and result
POST
Start a crawl job
GET
Get crawl job status and results
API Reference
Start a crawl job
POST
/
api
/
crawl
Send
Authorization
x-api-key
string
*
x-api-key
Required
string
Body
object
*
url
string
*
url
Required
string
maxPages
integer
maxPages
integer
followLinks
boolean
Select option
followLinks
boolean
excludePatterns
array
excludePatterns
array
includePatterns
array
includePatterns
array
useProxy
boolean
Select option
useProxy
boolean
solveCaptchas
boolean
Select option
solveCaptchas
boolean
Authorizations
x-api-key
string
header
required
Body
application/json
url
string
required
maxPages
integer
Required range:
x > 1
followLinks
boolean
excludePatterns
string[]
includePatterns
string[]
useProxy
boolean
default: false
solveCaptchas
boolean
default: false
Response
200 - application/json
jobId
string
required
Get scrape job status and result
Get crawl job status and results