Map
Map URLs
Returns the list of URLs found under the given base URL by combining sitemap parsing with HTML link extraction from the seed page. The optional search parameter filters the discovered URLs by case-insensitive substring match — it does NOT query a search engine.
Authorization
APIKeyHeader X-Api-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/map" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com" }'{
"success": true,
"links": [
{
"url": "string",
"source": "sitemap"
}
],
"warning": "string"
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}