> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beecrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Map a site



## OpenAPI

````yaml /docs/openapi.yaml post /map
openapi: 3.0.3
info:
  title: BeeCrawl API
  version: 0.1.0
  description: Self-hostable web scraping, crawling, search, and extraction API.
servers:
  - url: https://api.beecrawl.dev
    description: BeeCrawl hosted deployment
  - url: http://127.0.0.1:8000
    description: Local development
security:
  - apiKey: []
tags:
  - name: Scraping
  - name: Discovery
  - name: Async jobs
  - name: Search
  - name: Extraction
paths:
  /map:
    post:
      tags:
        - Discovery
      summary: Map a site
      operationId: mapSite
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapRequest'
      responses:
        '200':
          description: Discovered URLs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    MapRequest:
      type: object
      required:
        - url
      properties:
        url:
          type: string
          format: uri
        search:
          type: string
        limit:
          type: integer
          minimum: 1
          default: 100
        includeSubdomains:
          type: boolean
          default: false
        sitemap:
          type: string
          enum:
            - include
            - only
            - skip
          default: include
        ignore_sitemap:
          type: boolean
          default: false
        ignoreQueryParameters:
          type: boolean
          default: true
    MapResponse:
      type: object
      properties:
        request_id:
          type: string
        url:
          type: string
          format: uri
        links:
          type: array
          items:
            type: string
            format: uri
        metadata:
          type: object
          properties:
            provider:
              type: string
            count:
              type: integer
            elapsed_ms:
              type: integer
              nullable: true
    Error:
      type: object
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Web-Extract-Api-Key
      description: API key. X-Api-Key and Bearer authentication are also accepted.

````