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

# Preview sitemap URLs

> Reads a sitemap and returns the page URLs an import would turn into documents, without creating anything. Call it before creating from the sitemap to see the set, the plan's per-import limit, and whether the list was truncated.



## OpenAPI

````yaml /specs-prettified/realtime/openapi.stable.json post /v1/stable/document/sitemap/preview
openapi: 3.0.0
info:
  title: Realtime
  description: Realtime gateway API service
  version: 1.0.0
  contact: {}
servers:
  - url: https://realtime-api.voiceflow.com
security: []
tags: []
paths:
  /v1/stable/document/sitemap/preview:
    post:
      tags:
        - Document
      summary: Preview sitemap URLs
      description: Reads a sitemap and returns the page URLs an import would turn into
        documents, without creating anything. Call it before creating from the
        sitemap to see the set, the plan's per-import limit, and whether the
        list was truncated.
      operationId: StableDocumentController_previewSitemap
      parameters:
        - name: projectID
          required: true
          in: query
          schema:
            type: string
            description: The ID of the project to operate on.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StableDocumentSitemapRequest"
      responses:
        "200":
          description: Returns the URLs an import would create, the total the sitemap
            yields after `exclude`, the per-import limit, whether the list was
            truncated, and the counts excluded and dropped.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StableDocumentSitemapPreviewResponse"
          x-vf-doc:
            description: Returns the URLs an import would create, the total the sitemap
              yields after `exclude`, the per-import limit, whether the list was
              truncated, and the counts excluded and dropped.
      security:
        - token: []
components:
  schemas:
    StableDocumentSitemapRequest:
      type: object
      properties:
        sitemapURL:
          type: string
          format: uri
          description: The HTTPS URL of the sitemap to read. A bare site URL works too —
            when it does not end in `.xml`, `/sitemap.xml`, `/sitemap_index.xml`
            and `/sitemap/sitemap.xml` are probed in turn.
        exclude:
          description: "Patterns that drop a URL from the import when any one of them
            matches. Matching is case-insensitive and unanchored: a pattern with
            no `*` matches any URL containing it as a substring (`/blog/`),
            while `*` matches any run of characters (`*/tag/*`, `*.pdf`)."
          maxItems: 100
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 200
      required:
        - sitemapURL
      additionalProperties: false
    StableDocumentSitemapPreviewResponse:
      type: object
      properties:
        urls:
          type: array
          items:
            type: string
          description: The URLs that would be imported, in sitemap order, capped at
            `limit` entries.
        total:
          type: number
          description: How many URLs the sitemap yields once `exclude` is applied, before
            the cap.
        limit:
          type: number
          description: The most URL documents this plan allows in a single import.
        truncated:
          type: boolean
          description: True when `total` is above `limit`, meaning `urls` is only part of
            what the sitemap holds.
        excluded:
          type: number
          description: How many valid URLs the `exclude` patterns removed. Zero when no
            patterns were given.
        dropped:
          type: number
          description: How many entries the sitemap listed that are not usable URLs and
            were skipped.
      required:
        - urls
        - total
        - limit
        - truncated
        - excluded
        - dropped
  securitySchemes:
    token:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Voiceflow bearer token
````