---
title: "Map Site"
method: POST
path: "/api/v1/map"
---

# Map Site

`POST /api/v1/map`

## Request

- Base URL: `https://api.mesharc.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mesharc.dev/api/v1/map`
- Auth: none declared

Every URL a site declares, from its sitemaps.

The same discovery a project does before its first run -- robots.txt,
the well-known paths, the index files walked to their children -- read
through the same ladder, so a site that needs a browser to serve its
sitemap still answers. Inline when it resolves inside `timeout`
(10 s by default), otherwise 202 and the id to poll.

## Headers

- `authorization` string, nullable
- `x-mesharc-tenant` string, nullable

## Request body

- MapRequest
  - `url` string, required
  - `search` string, nullable
  - `limit` integer, nullable
  - `sitemapMode` string, nullable
  - `sitemaps` string[], nullable
  - `includePaths` string[], nullable
  - `excludePaths` string[], nullable
  - `allowSubdomains` boolean, nullable
  - `maxTier` string, nullable
  - `timeout` number, nullable
  - `config` object, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

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