curl --request POST \
--url https://api.olostep.com/v1/maps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://docs.olostep.com"
}
'{
"id": "map_abc123",
"urls_count": 22,
"urls": [
"https://docs.olostep.com/api-reference/batches/create",
"https://docs.olostep.com/api-reference/batches/info",
"https://docs.olostep.com/api-reference/batches/items"
]
}Maps
Create Map
This endpoint allows users to get all the urls on a certain website. It can take up to 120 seconds for complex websites. For large websites, results are paginated using cursor-based pagination
POST
/
v1
/
maps
curl --request POST \
--url https://api.olostep.com/v1/maps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://docs.olostep.com"
}
'{
"id": "map_abc123",
"urls_count": 22,
"urls": [
"https://docs.olostep.com/api-reference/batches/create",
"https://docs.olostep.com/api-reference/batches/info",
"https://docs.olostep.com/api-reference/batches/items"
]
}Result retention: Pass
storage.expires_in to keep this map’s stored files longer than the default of 7 days. Values: 7d, 10d, 30d, 60d, 90d, 180d, 365d, or never. See Storage for details.Authorizations
Body
application/json
Controls how long this map's stored files (its result and the pages scraped during discovery) are retained. When omitted, they are kept for 7 days. The value in effect is returned in the response as storage.expires_in. See the Storage section in the feature docs. An invalid value returns 400 with code invalid_storage_expires_in.
Show child attributes
Show child attributes
Response
Successful response with URLs found on the page
Was this page helpful?