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

# Post map

> Maps a website and returns its structure. Costs 5 credits per request.



## OpenAPI

````yaml api-reference/openapi.json post /map
openapi: 3.0.1
info:
  title: Norns AI API
  description: API documentation for Norns AI services
  version: 1.0.0
servers:
  - url: https://www.norns.ai/api/v0
    description: Production server
security:
  - bearerAuth: []
paths:
  /map:
    post:
      description: Maps a website and returns its structure. Costs 5 credits per request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapRequest'
      responses:
        '200':
          description: Successful mapping response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    MapRequest:
      type: object
      required:
        - url
      properties:
        url:
          type: string
          description: The URL to map (must include protocol)
        ignoreSitemap:
          type: boolean
          description: Whether to ignore the sitemap
        includeSubdomains:
          type: boolean
          description: Whether to include subdomains in the mapping
        limit:
          type: integer
          description: Maximum number of pages to map (1-5000)
          minimum: 1
          maximum: 5000
        search:
          type: string
          description: Search term to filter pages
        sitemapOnly:
          type: boolean
          description: Whether to only use sitemap for mapping
        enrichLinks:
          type: boolean
          description: Whether to enrich links with additional data
    MapResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
    Error:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication

````