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"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

The URL of the website for which you want the links

search_query
string

An optional search query to sort the links by search relevance.

top_n
number

An optional number to limit to only top n links for a search query.

include_urls
string[]

URL path patterns to include using glob syntax. For example: /blog/** to only include blog URLs. Only URLs matching these patterns will be returned.

exclude_urls
string[]

URL path patterns to exclude using glob syntax. For example: /careers/**. Excluded URLs will supersede included URLs.

cursor
string

OPTIONAL: Pagination cursor from a previous response. When provided, returns the next set of URLs from where the previous request left off due to response size limit.

Response

200
application/json
Successful response with URLs found on the page
urls_count
integer
required

Number of URLs in the current response

urls
string[]
required

Array of URLs found on the page

id
string

Unique identifier for this map

cursor
string

Pagination cursor to retrieve the next set of URLs limited due to 10MB size limit. If null or not present, all URLs have been retrieved.