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

# Add sitemap

> Ingest a sitemap into chatbot knowledge. Supports auto-sync and sitemap auto-scan frequencies.

Required scope: `knowledge:write`.



## OpenAPI

````yaml openapi-v2.json POST /api/v2/chatbots/{chatbotId}/knowledge/sitemap
openapi: 3.1.0
info:
  title: SiteGPT Agent API
  version: 2.0.0
  description: >-
    Agent-facing API for managing SiteGPT chatbots, dashboard summaries,
    appearance media, knowledge, settings, conversations, leads, members,
    account profiles, usage, billing reads, and API tokens.
servers:
  - url: https://sitegpt.ai
security:
  - bearerAuth: []
tags:
  - name: Discovery
  - name: Onboarding
  - name: Account
  - name: Billing
  - name: Tokens
  - name: Chatbots
  - name: Knowledge
  - name: Knowledge Sync Jobs
  - name: Knowledge Sources
  - name: Custom Responses
  - name: Personas
  - name: Instructions
  - name: Settings
  - name: Conversation Starters
  - name: Conversation Followups
  - name: Members
  - name: Leads
  - name: Conversations
  - name: Messages
  - name: Tags
paths:
  /api/v2/chatbots/{chatbotId}/knowledge/sitemap:
    post:
      tags:
        - Knowledge
      summary: Add sitemap
      description: >-
        Ingest a sitemap into chatbot knowledge. Supports auto-sync and sitemap
        auto-scan frequencies.


        Required scope: `knowledge:write`.
      operationId: addKnowledgeSitemap
      parameters:
        - name: chatbotId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              additionalProperties: false
              properties:
                url:
                  type: string
                  format: uri
                maxLinks:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 50
                includePaths:
                  type: array
                  items:
                    type: string
                excludePaths:
                  type: array
                  items:
                    type: string
                syncFrequency:
                  type: string
                  enum:
                    - NEVER
                    - DAILY
                    - WEEKLY
                    - MONTHLY
                  default: NEVER
                scanFrequency:
                  type: string
                  enum:
                    - NEVER
                    - DAILY
                    - WEEKLY
                    - MONTHLY
                  default: NEVER
                scrapeOptions:
                  type: object
                  additionalProperties: false
                  properties:
                    onlyMainContent:
                      type: boolean
                      default: true
                      description: >-
                        Extract main page content only, excluding headers,
                        footers, sidebars, and navigation.
                    includeSelectors:
                      type: array
                      items:
                        type: string
                      description: CSS selectors to include when scraping page content.
                    excludeSelectors:
                      type: array
                      items:
                        type: string
                      description: CSS selectors to exclude when scraping page content.
                    headers:
                      type: object
                      additionalProperties:
                        type: string
                      description: >-
                        Allowed request headers: User-Agent, Accept,
                        Accept-Language.
                metadata:
                  type: object
                  additionalProperties: true
            example:
              url: https://example.com/sitemap.xml
              maxLinks: 1000
              syncFrequency: WEEKLY
              scanFrequency: DAILY
              scrapeOptions:
                onlyMainContent: true
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                  - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      document:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  document:
                    id: document-id
                    name: Example document
                    createdAt: '2026-05-13T00:00:00.000Z'
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
      security:
        - bearerAuth:
            - knowledge:write
components:
  schemas:
    GenericObject:
      type: object
      additionalProperties: true
    AgentResponseMeta:
      type: object
      required:
        - requestId
      properties:
        requestId:
          type: string
        warnings:
          type: array
          items:
            type: string
        nextCursor:
          type:
            - string
            - 'null'
      additionalProperties: true
    AgentError:
      type: object
      required:
        - ok
        - error
        - meta
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          additionalProperties: false
        meta:
          type: object
          required:
            - requestId
          properties:
            requestId:
              type: string
          additionalProperties: true
      additionalProperties: false
  responses:
    AgentError:
      description: SiteGPT agent API error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AgentError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: SiteGPT API token

````