Start a crawl job

post/api/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/crawl/post.ts
A function with typed inputs. Its response is checked against the schema.

urlstring required

maxPagesinteger

followLinksboolean

ignoreSitemapboolean

excludePatternsstring[]

includePatternsstring[]

{
  "sessionOptions": {
    "proxyCity": "new york"
  }
}

Crawl job started successfully

jobIdstring required

Oct 15, 2026225d94fe61a0 Revision changes
- info
  added subschema #4 to the // request property oneOf list
Oct 15, 20266ca0b00ee564 Revision changes
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /