Skip to main content

POST /discovery

This endpoint starts a URL discovery job for a website. It returns a discoveryId that can be used to track the job’s progress and retrieve discovered URLs.

Request Body

string
required
The URL of the website to discover. Must be a valid URL with http/https protocol.
number
default:"50"
The maximum number of URLs to discover. Range: 1-1000.
string
default:"full"
The method to use for discovery:
  • full: Combines sitemap parsing and crawling for comprehensive discovery
  • sitemap: Only parses sitemap.xml files
  • crawl: Only crawls pages by following links

Response

string
A unique identifier for the discovery job.
string
The URL being discovered.
string
The status of the job: started, processing, completed, or failed.
string
The discovery method being used.
number
Maximum URLs to discover.
string
Progress percentage.
number
Number of URLs discovered so far.
string
ISO 8601 timestamp of job creation.
string
Estimated completion time.