Start a web crawl job

Starts an asynchronous crawl job that follows links from a starting URL and returns content from each page in the specified formats.

post/api/web/crawl

Request

Base URL
https://api.hyperbrowser.ai
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/hyperbrowser/apis/hyperbrowser-api/docs/api/web/crawl/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

urlstring required

stealth'none' | 'auto' | 'ultra'

Response

Crawl job started successfully

jobIdstring required

Changes

No recorded changes to this operation across all 27 revisions of this API.