SiteGPT

https://sitegpt.ai/docs
Admin
SiteGPT is an AI-powered chatbot platform that automates customer support, captures leads, and...
Tokens:251,768
Snippets:2,309
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Installation Snippet

Source: https://sitegpt.ai/docs/cli/command-reference

Obtain the necessary metadata to embed your chatbot widget, including chat URL, script URL, and embed code.

```bash
sitegpt installation snippet --chatbot <chatbot-id>
```

--------------------------------

### Install SiteGPT CLI

Source: https://sitegpt.ai/docs/cli/overview

Install the SiteGPT CLI globally using npm. Verify the installation by checking the version.

```bash
npm install -g @sitegpt/cli
sitegpt --version
```

--------------------------------

### Install SiteGPT CLI

Source: https://sitegpt.ai/docs/cli/install-login

Install the CLI globally using npm. This command ensures the SiteGPT CLI is available system-wide.

```bash
npm install -g @sitegpt/cli
```

--------------------------------

### Login with Full Access for Setup Agent

Source: https://sitegpt.ai/docs/cli/use-with-ai-agents

This command logs in with a setup agent profile granting full access. It's convenient for trusted local agents but less secure than scoped profiles for repeated workflows.

```bash
sitegpt login --profile setup-agent --full-access
```

--------------------------------

### Example API v2 Request

Source: https://sitegpt.ai/docs/api-reference/v2/getting-started

Example of how to make a request to the API v2 `/me` endpoint using curl, including the Authorization header.

```bash
curl https://sitegpt.ai/api/v2/me \
  -H "Authorization: Bearer sgpt_xxxxxxxxx"
```

--------------------------------

### Authorize Knowledge Source Request Example

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/knowledge-sources/authorize-knowledge-source

This example demonstrates how to make a POST request to authorize a knowledge source. It includes the chatbot ID and connection ID in the URL and an optional `clientRedirectUrl` in the request body.

```json
{
  "clientRedirectUrl": "https://sitegpt.ai/agents/files-selected"
}
```

--------------------------------

### Get SiteGPT Installation Snippet

Source: https://sitegpt.ai/docs/cli/chatbots

Retrieve the embeddable script snippet and installation metadata for a chatbot. The --json flag provides structured data including chat and widget URLs.

```bash
sitegpt installation snippet --chatbot <chatbot-id>
```

```bash
sitegpt installation snippet --chatbot <chatbot-id> --json
```

--------------------------------

### Recommended Chatbot Setup Order: Create Chatbot

Source: https://sitegpt.ai/docs/cli/chatbots

The first step in setting up a new chatbot is to create it using the CLI, providing a title and an optional description. The --json flag is recommended for programmatic use.

```bash
sitegpt chatbots create "Brand Support" --description "Answers questions about Brand." --json
```

--------------------------------

### Login with Manual Token Setup

Source: https://sitegpt.ai/docs/cli/use-with-ai-agents

Use this command to log in using a SiteGPT API token obtained from the dashboard. Replace `<sitegpt-api-token>` with your actual token.

```bash
sitegpt login --profile sitegpt-agent --token <sitegpt-api-token>
```

--------------------------------

### Get Instruction OpenAPI Specification

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/instructions/get-instruction

This OpenAPI specification defines the GET endpoint for retrieving a single chatbot instruction. It includes request parameters, response schemas, and an example of a successful response.

```yaml
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: 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}/instructions/{instructionId}:
    get:
      tags:
        - Instructions
      summary: Get instructions
      description: |-
        Get one chatbot instruction.

        Required scope: `instructions:read`.
      operationId: getInstruction
      parameters:
        - name: chatbotId
          in: path
          required: true
          schema:
            type: string
        - name: instructionId
          in: path
          required: true
          schema:
            type: string
      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:
                      instruction:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  instruction:
                    id: instruction-id
                    name: Example instruction
                    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:
            - instructions:read
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

```

--------------------------------

### Add and Use Instructions

Source: https://sitegpt.ai/docs/cli/command-reference

Demonstrates adding a new instruction set from a file with a specified temperature and then using an existing instruction set.

```bash
sitegpt instructions add --chatbot <chatbot-id> --file ./instructions.md --temperature 0.3 --json
```

```bash
sitegpt instructions use --chatbot <chatbot-id> <instruction-id>
```

--------------------------------

### Get Current User OpenAPI Specification

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/account/get-me

This OpenAPI specification defines the GET /api/v2/me endpoint for retrieving the authenticated user and credential context. It includes request details, response schemas, and example payloads.

```yaml
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: 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/me:
    get:
      tags:
        - Account
      summary: Get current user
      description: |-
        Get the authenticated user and credential context.

        Requires a valid SiteGPT bearer token.
      operationId: getMe
      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:
                      user:
                        $ref: '#/components/schemas/GenericObject'
                      auth:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  user:
                    id: user-id
                    email: user@example.com
                    name: SiteGPT User
                  auth:
                    type: api-token
                    scopes: []
                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: []
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

```

--------------------------------

### Display Contextual Help for SiteGPT CLI

Source: https://sitegpt.ai/docs/cli/overview

Use the `--help` option at any command level to display contextual help, including available subcommands, options, enum values, defaults, and examples. This is useful for both manual use and for AI agents.

```bash
sitegpt --help
```

```bash
sitegpt knowledge --help
```

```bash
sitegpt knowledge documents --help
```

```bash
sitegpt settings appearance --help
```

```bash
sitegpt conversations --help
```

--------------------------------

### OpenAPI Specification for Get Tag

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/tags/get-tag

This OpenAPI v3 specification defines the GET endpoint for retrieving a single tag. It includes request parameters, response schemas, and example payloads. Requires `conversations:read` scope.

```yaml
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: 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}/tags/{tagId}:
    get:
      tags:
        - Tags
      summary: Get tag
      description: |-
        Get one conversation tag.

        Required scope: `conversations:read`.
      operationId: getTag
      parameters:
        - name: chatbotId
          in: path
          required: true
          schema:
            type: string
        - name: tagId
          in: path
          required: true
          schema:
            type: string
      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:
                      tag:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  tag:
                    id: tag-id
                    name: Example tag
                    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:
            - conversations:read
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

```

--------------------------------

### Get Help for Knowledge Commands

Source: https://sitegpt.ai/docs/cli/knowledge

Run this command first to explore all available knowledge management options and their usage.

```bash
sitegpt knowledge --help
```

--------------------------------

### OpenAPI Specification for Get Conversation

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/conversations/get-conversation

This OpenAPI specification defines the GET endpoint for retrieving a single chatbot conversation. It includes path parameters for chatbotId and threadId, required scopes, and example responses for success and error cases.

```yaml
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: 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}/conversations/{threadId}:
    get:
      tags:
        - Conversations
      summary: Get conversation
      description: |-
        Get one chatbot conversation.

        Required scope: `conversations:read`.
      operationId: getConversation
      parameters:
        - name: chatbotId
          in: path
          required: true
          schema:
            type: string
        - name: threadId
          in: path
          required: true
          schema:
            type: string
      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:
                      conversation:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  conversation:
                    id: conversation-id
                    name: Example conversation
                    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:
            - conversations:read
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

```

--------------------------------

### OpenAPI Specification for Get Settings Section

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/settings/get-settings-section

This OpenAPI specification defines the GET endpoint for retrieving a specific settings section of a chatbot. It outlines the request parameters, including chatbot ID and section name, and the structure of the successful response, including an example.

```yaml
````yaml /openapi-v2.json GET /api/v2/chatbots/{chatbotId}/settings/{section}
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: 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}/settings/{section}:
    get:
      tags:
        - Settings
      summary: Get settings section
      description: |-
        Get one safe chatbot settings section.

        Required scope: `settings:read`.
      operationId: getSettingsSection
      parameters:
        - name: chatbotId
          in: path
          required: true
          schema:
            type: string
        - name: section
          in: path
          required: true
          schema:
            type: string
      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:
                      setting:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  setting:
                    id: setting-id
                    name: Example setting
                    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:
            - settings:read
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

````
```

--------------------------------

### OpenAPI Specification for Get Chatbot Dashboard

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/chatbots/get-chatbot-dashboard

This OpenAPI specification defines the GET /api/v2/chatbots/{chatbotId}/dashboard endpoint. It outlines the request parameters, response structure for a successful retrieval (200 OK), and potential error responses. The example demonstrates a successful response payload.

```yaml
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: 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}/dashboard:
    get:
      tags:
        - Chatbots
      summary: Get dashboard summary
      description: >-
        Get chatbot dashboard summary, knowledge counts, conversation feedback,
        and install metadata.


        Required scope: `chatbots:read`.
      operationId: getChatbotDashboard
      parameters:
        - name: chatbotId
          in: path
          required: true
          schema:
            type: string
      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:
                      chatbot:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  chatbot:
                    id: chatbot-id
                    name: Example chatbot
                    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:
            - chatbots:read
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

```

--------------------------------

### Create Instructions Text File

Source: https://sitegpt.ai/docs/cli/playbooks/create-chatbot-from-website

Write the chatbot's operational instructions to a temporary markdown file.

```bash
cat > /tmp/sitegpt-instructions.md <<'EOF'
Answer using the chatbot knowledge first.
If the answer is not available in the knowledge base, say that you do not have enough information and suggest contacting support.
Keep answers concise unless the visitor asks for detail.
Do not invent prices, policies, or guarantees.
When useful, suggest a follow-up question the visitor can ask next.
EOF
```

--------------------------------

### Get Chatbot Dashboard Summary

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/chatbots/get-chatbot-dashboard

Fetches the dashboard summary for a given chatbot, including knowledge counts, conversation feedback, and install metadata. Requires `chatbots:read` scope.

```APIDOC
## GET /api/v2/chatbots/{chatbotId}/dashboard

### Description
Get chatbot dashboard summary, knowledge counts, conversation feedback, and install metadata.

### Method
GET

### Endpoint
/api/v2/chatbots/{chatbotId}/dashboard

### Parameters
#### Path Parameters
- **chatbotId** (string) - Required - The unique identifier of the chatbot.

### Responses
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the chatbot data.
  - **chatbot** (object) - Details of the chatbot.
- **meta** (object) - Metadata about the response.
  - **requestId** (string) - The unique identifier for the request.

#### Response Example
```json
{
  "ok": true,
  "data": {
    "chatbot": {
      "id": "chatbot-id",
      "name": "Example chatbot",
      "createdAt": "2026-05-13T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "request-id"
  }
}
```

#### Error Responses
- **400**: Bad Request
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not Found
- **405**: Method Not Allowed
```

--------------------------------

### Authenticate and Verify

Source: https://sitegpt.ai/docs/cli/overview

Initial steps to authenticate with SiteGPT CLI and verify the current user.

```bash
# Authenticate
sitegpt login
sitegpt whoami
```

--------------------------------

### List Chatbots OpenAPI Specification

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/chatbots/list-chatbots

This OpenAPI specification defines the GET /api/v2/chatbots endpoint for listing chatbots. It includes request parameters, response schemas, and example responses. Ensure you have the `chatbots:read` scope to access this endpoint.

```yaml
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: 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:
    get:
      tags:
        - Chatbots
      summary: List chatbots
      description: |-
        List chatbots accessible to the authenticated user.

        Required scope: `chatbots:read`.
      operationId: listChatbots
      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:
                      chatbots:
                        type: array
                        items:
                          $ref: '#/components/schemas/GenericObject'
                      pagination:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  chatbots:
                    - id: chatbot-id
                      name: Example chatbot
                      createdAt: '2026-05-13T00:00:00.000Z'
                  pagination:
                    limit: 20
                    hasNextPage: false
                    nextCursor: null
                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:
            - chatbots:read
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

```

--------------------------------

### List Members OpenAPI Specification

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/members/list-members

This OpenAPI specification defines the GET request for the /api/v2/chatbots/{chatbotId}/members endpoint. It includes details on parameters, responses, and example payloads for listing members and pending invites. Requires the `members:read` scope.

```yaml
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: 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}/members:
    get:
      tags:
        - Members
      summary: List members
      description: |-
        List chatbot members and pending invites.

        Required scope: `members:read`.
      operationId: listMembers
      parameters:
        - name: chatbotId
          in: path
          required: true
          schema:
            type: string
      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:
                      members:
                        type: array
                        items:
                          $ref: '#/components/schemas/GenericObject'
                      pendingInvites:
                        type: array
                        items:
                          $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  members:
                    - id: member-id
                      name: Example member
                      createdAt: '2026-05-13T00:00:00.000Z'
                  pagination:
                    limit: 20
                    hasNextPage: false
                    nextCursor: null
                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:
            - members:read
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

```

--------------------------------

### Show help for knowledge sources

Source: https://sitegpt.ai/docs/cli/data-sources

Displays help information for managing data sources. Use this to understand available commands and options.

```bash
sitegpt knowledge sources --help
```

--------------------------------

### Get Contextual Help for SiteGPT Commands

Source: https://sitegpt.ai/docs/cli/troubleshooting

Use the --help flag at different command levels to resolve UNKNOWN_COMMAND errors and understand available options.

```bash
sitegpt --help
sitegpt knowledge --help
sitegpt knowledge documents --help
sitegpt settings --help
```

--------------------------------

### OpenAPI Specification for Get Agent Manifest

Source: https://sitegpt.ai/docs/api-reference/v2/endpoints/discovery/get-agent-manifest

This OpenAPI 3.1.0 specification defines the endpoint for retrieving the SiteGPT agent manifest. It includes details on the request method, path, parameters, and expected responses, including a successful 200 response with an example payload.

```yaml
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: 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:
  /.well-known/sitegpt-agent.json:
    get:
      tags:
        - Discovery
      summary: Get agent manifest
      description: |-
        Get the SiteGPT agent manifest.

        No authentication is required.
      operationId: getAgentManifest
      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:
                      discovery:
                        $ref: '#/components/schemas/GenericObject'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  discovery:
                    id: discovery-id
                    name: Example discovery
                    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: []
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

```
Tokens:
Raw