Skip to main content
Map Site

Authorizations

Authorization
string
header
required

API key for public endpoints; Clerk session for account endpoints.

Headers

Idempotency-Key
string | null

Body

application/json

Configure URL discovery for one site.

url
string
required
Required string length: 1 - 8192
filterByPath
boolean
default:true
ignoreQueryParameters
boolean
default:true
ignoreSitemap
boolean
default:false
includeSubdomains
boolean
default:false
limit
integer
default:5000
Required range: 1 <= x <= 50000
search
string | null

Substring filter on the URL

Maximum string length: 1000
sitemap
enum<string>
default:include
Available options:
include,
skip,
only
timeout
integer
default:30000
Required range: x <= 120000

Response

Successful Response

data
MapResponse · object | null
required
message
string | null
required
meta
Meta · object | null
required
request_id
string | null
required
success
boolean
default:true
required