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

# Map

> Discover URLs reachable from one or more seed URLs, without fetching each page's full content.



## OpenAPI

````yaml post /v1/map
openapi: 3.1.0
info:
  title: Scrapio
  version: 1.0.0
  description: >-
    Turn any URL into structured data. Fetch raw HTML, crawl sites, extract
    structured content, interact with dynamic pages, and search the web through
    one API.
  contact:
    name: Scrapio Support
    url: https://scrapio.dev
  license:
    name: Proprietary
servers:
  - url: https://api.scrapio.dev
    description: Production
security:
  - bearerAuth: []
tags:
  - name: System
  - name: Fetch
  - name: Crawl
  - name: Map
  - name: Interact
  - name: Search
  - name: Google
  - name: Fast Search
  - name: Jobs
  - name: YouTube
  - name: Amazon
  - name: Walmart
  - name: Booking
  - name: Agoda
  - name: Airbnb
  - name: ChatGPT
  - name: Perplexity
  - name: Gemini
  - name: Bing
  - name: Reddit
  - name: TikTok
  - name: Apple App Store
  - name: Target
  - name: Monitors
paths:
  /v1/map:
    post:
      tags:
        - Map
      summary: Map a site's URLs from seed URLs
      description: >-
        Discovers URLs reachable from one or more seed URLs, capped by
        `max_urls`/`max_depth`, without fetching each page's full content. Set
        `include_metadata: true` to also return per-URL page metadata (like
        title).
      operationId: createMap
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapRequest'
            examples:
              basic:
                summary: Map with metadata
                value:
                  seeds:
                    - https://example.com
                  include_metadata: true
      responses:
        '200':
          description: Map completed inline.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowEnvelopeResponse'
              example:
                id: 0cf982f8-99c8-4641-9d12-b0d7191bf782
                request_id: 0cf982f8-99c8-4641-9d12-b0d7191bf782
                kind: map
                mode: inline
                status: completed
                steps:
                  - step_id: step_map_discover
                    type: map_discover
                    status: completed
                    started_at: '2026-07-17T14:27:49.333Z'
                    completed_at: '2026-07-17T14:27:49.392Z'
                result:
                  seeds:
                    - https://example.com
                  urls:
                    - url: https://example.com/
                      depth: 0
                      discovered_from: null
                      metadata:
                        title: Example Domain
                  summary:
                    urls_discovered: 2
                    urls_returned: 1
                    urls_skipped: 1
                    frontier_exhausted: true
                diagnostics:
                  step_errors: []
        '400':
          description: Invalid map parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Daily credit cap exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: |-
            curl -X POST https://api.scrapio.dev/v1/map \
              -H "Authorization: Bearer $SCRAPIO_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{"seeds":["https://example.com"],"include_metadata":true}'
components:
  schemas:
    MapRequest:
      type: object
      properties:
        seeds:
          minItems: 1
          type: array
          items:
            type: string
            format: uri
          description: Starting URLs to map from
        max_urls:
          description: Cap on total URLs returned
          type: integer
          exclusiveMinimum: 0
          maximum: 100
        max_depth:
          description: Max link depth from seeds
          type: integer
          minimum: 0
          maximum: 5
        same_domain_only:
          description: Restrict mapping to seed domains
          type: boolean
        include_metadata:
          description: Include page metadata in results
          type: boolean
        timeout_ms:
          description: Max mapping duration, in ms
          type: integer
          exclusiveMinimum: 0
          maximum: 300000
        use_proxy:
          description: >-
            Skip the cheap direct/stealth tiers and go straight to the strongest
            (proxy) access tier for every URL mapped. Requires a paid plan.
          type: boolean
      required:
        - seeds
      additionalProperties: false
    WorkflowEnvelopeResponse:
      type: object
      description: >-
        Common envelope every workflow endpoint (crawl, map, interact, search)
        returns: request/step metadata plus a kind-specific `result`.
      properties:
        id:
          type: string
        request_id:
          type: string
        kind:
          type: string
          enum:
            - crawl
            - map
            - interact
            - search
        mode:
          type: string
          enum:
            - inline
        status:
          type: string
          enum:
            - completed
            - partial
            - failed
        steps:
          type: array
          items:
            type: object
        result:
          type: object
          description: Kind-specific payload -- see the endpoint's example.
        diagnostics:
          type: object
      required:
        - id
        - request_id
        - kind
        - mode
        - status
        - result
    ErrorResponse:
      type: object
      properties:
        request_id:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
        diagnostics:
          type: object
          properties:
            outcome:
              type: string
              enum:
                - failed
            retryable:
              type: boolean
            blocked:
              type: boolean
            timed_out:
              type: boolean
          required:
            - outcome
            - retryable
          additionalProperties: false
      required:
        - request_id
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````