---
title: "Create a map"
method: POST
path: "/v1/maps"
tags: ["maps"]
---

# Create a map

`POST /v1/maps`

## Request

- Base URL: `https://api.olostep.com`
- URL: `https://api.olostep.com/v1/maps`
- Auth: HTTP bearer

Discovers URLs across a site.

## Request body

- object
  - `url` string, uri, required: The site URL to map.
  - `search_query` string
  - `top_n` integer
  - `include_subdomain` boolean
  - `include_urls` string[]
  - `exclude_urls` string[]
  - `cursor` string: Pagination cursor from a previous response.

## Response `200`

Default Response

- object: A map resource.
  - `id` string, required
  - `urls_count` integer, required
  - `urls` string[], required
  - `cursor` string, nullable
  - `credits_consumed` number, nullable
  - `cost_usd` number, nullable
  - `url` string
  - `created_at` string
  - `folder_count` object[]
    - `folder` string, required
    - `count` number, required

## Other responses

- `400`: Default Response
- `401`: Default Response
- `429`: Default Response
- `502`: Default Response
- `504`: Default Response

---

[API](https://skmtc.dev/olostep/apis/olostep-api.md) · [All operations](https://skmtc.dev/olostep/apis/olostep-api/llms.txt) · [OpenAPI document](https://skmtc.dev/olostep/apis/olostep-api/revisions/13c766ab100c?raw)