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

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

await client.crawl.start({
  url: 'https://example.com',
  scrapeOptions: {
    formats: ['markdown']
  }
});
{
  "jobId": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
url
string
required
maxPages
integer
Required range: x >= 1
ignoreSitemap
boolean
default:false
excludePatterns
string[]
includePatterns
string[]
sessionOptions
object
scrapeOptions
object

Response

Crawl job started successfully

jobId
string
required