find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/sitegpt-ai:sitegpt-ai-settings-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: SiteGPT Agent Settings 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: Settings
paths:
  /api/v2/chatbots/{chatbotId}/settings:
    get:
      operationId: getSettings
      summary: Get settings
      description: 'Get safe chatbot settings.


        Required scope: `settings:read`.


        On success, `data` contains: `settings`, `sections`.'
      tags:
      - Settings
      security:
      - bearerAuth:
        - settings:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - settings:read
      x-mint:
        title: Get settings
        description: Get safe chatbot settings.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        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:
                      settings:
                        $ref: '#/components/schemas/GenericObject'
                        description: Map of settings section name to that section payload.
                      sections:
                        type: array
                        items:
                          type: string
                        description: Names of every settings section.
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  settings:
                    general:
                      title: Example chatbot
                  sections:
                  - general
                  - ai
                  - localization
                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'
    patch:
      operationId: updateSettings
      summary: Update settings
      description: 'Update safe chatbot settings across sections.


        Required scope: `settings:write`.


        On success, `data` contains: `settings`, `updatedSections`.'
      tags:
      - Settings
      security:
      - bearerAuth:
        - settings:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - settings:write
      x-mint:
        title: Update settings
        description: Update safe chatbot settings across sections.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              description: Partial safe chatbot settings patch. Only public dashboard settings accepted by API v2 can be changed.
      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:
                      settings:
                        $ref: '#/components/schemas/GenericObject'
                        description: Map of settings section name to that section payload.
                      updatedSections:
                        type: array
                        items:
                          type: string
                        description: Names of the sections this update touched.
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  settings:
                    general:
                      title: Example chatbot
                  updatedSections:
                  - general
                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'
  /api/v2/chatbots/{chatbotId}/settings/{section}:
    get:
      operationId: getSettingsSection
      summary: Get settings section
      description: 'Get one safe chatbot settings section.


        Required scope: `settings:read`.


        On success, `data` contains: `section`, `settings`.'
      tags:
      - Settings
      security:
      - bearerAuth:
        - settings:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - settings:read
      x-mint:
        title: Get settings section
        description: Get one safe chatbot settings section.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: section
        in: path
        required: true
        description: Settings section name, as listed by GET /settings.
        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:
                      section:
                        type: string
                      settings:
                        $ref: '#/components/schemas/GenericObject'
                        description: The requested settings section.
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  section: general
                  settings:
                    title: Example chatbot
                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'
    patch:
      operationId: updateSettingsSection
      summary: Update settings section
      description: 'Update one safe chatbot settings section.


        Required scope: `settings:write`.


        On success, `data` contains: `section`, `settings`.'
      tags:
      - Settings
      security:
      - bearerAuth:
        - settings:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - settings:write
      x-mint:
        title: Update settings section
        description: Update one safe chatbot settings section.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: section
        in: path
        required: true
        description: Settings section name, as listed by GET /settings.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              description: Partial safe chatbot settings patch. Only public dashboard settings accepted by API v2 can be changed.
      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:
                      section:
                        type: string
                      settings:
                        $ref: '#/components/schemas/GenericObject'
                        description: The updated settings section.
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  section: general
                  settings:
                    title: Example chatbot
                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'
components:
  schemas:
    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
    AgentResponseMeta:
      type: object
      required:
      - requestId
      properties:
        requestId:
          type: string
        warnings:
          type: array
          items:
            type: string
        nextCursor:
          type:
          - string
          - 'null'
      additionalProperties: true
    GenericObject:
      type: object
      additionalProperties: true
  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