sitegpt-ai

sitegpt-ai Knowledge Sync Jobs API

The Knowledge Sync Jobs API from sitegpt-ai — 2 operation(s) for knowledge sync jobs.

GitHub OpenAPI

Operations 4

GET /api/v2/chatbots/{chatbotId}/ingest-jobs List sync jobs #
GET /api/v2/chatbots/{chatbotId}/ingest-jobs/{jobId} Get sync job #
PATCH /api/v2/chatbots/{chatbotId}/ingest-jobs/{jobId} Update sync job #
DELETE /api/v2/chatbots/{chatbotId}/ingest-jobs/{jobId} Delete sync job #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sitegpt-ai/openapi/sitegpt-ai-knowledge-sync-jobs-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-conversation-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-chatbot-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-message-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-billing-subscription-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-invoice-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-knowledge-document-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-knowledge-sync-jobs-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

sitegpt-ai-knowledge-sync-jobs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SiteGPT Agent Knowledge Sync Jobs 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: Knowledge Sync Jobs
paths:
  /api/v2/chatbots/{chatbotId}/ingest-jobs:
    get:
      operationId: listKnowledgeSyncJobs
      summary: List sync jobs
      description: 'List active recurring knowledge sync/scan jobs.


        Required scope: `knowledge:read`.


        On success, `data` contains: `syncJobs`, `stats`, `filters`, `pagination`.'
      tags:
      - Knowledge Sync Jobs
      security:
      - bearerAuth:
        - knowledge:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - knowledge:read
      x-mint:
        title: List sync jobs
        description: List active recurring knowledge sync/scan jobs.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum number of records to return.
        schema:
          type: integer
          minimum: 1
      - name: cursor
        in: query
        required: false
        description: Pagination cursor.
        schema:
          type: string
      - name: source
        in: query
        required: false
        description: Repeatable sync job source filter.
        schema:
          type: array
          items:
            type: string
      - name: syncFrequency
        in: query
        required: false
        description: Repeatable sync frequency filter.
        schema:
          type: array
          items:
            type: string
            enum:
            - DAILY
            - WEEKLY
            - MONTHLY
      - name: scanFrequency
        in: query
        required: false
        description: Repeatable sitemap scan frequency filter.
        schema:
          type: array
          items:
            type: string
            enum:
            - NEVER
            - DAILY
            - WEEKLY
            - MONTHLY
      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:
                      syncJobs:
                        type: array
                        items:
                          $ref: '#/components/schemas/IngestJob'
                      stats:
                        $ref: '#/components/schemas/GenericObject'
                        description: Job counts by source and by sync/scan frequency, total and filtered.
                      filters:
                        $ref: '#/components/schemas/GenericObject'
                        description: Echo of the applied source and frequency filters (null members when unfiltered).
                      pagination:
                        $ref: '#/components/schemas/Pagination'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  syncJobs:
                  - id: job-id
                    source: SITEMAP
                    syncFrequency: WEEKLY
                  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'
  /api/v2/chatbots/{chatbotId}/ingest-jobs/{jobId}:
    get:
      operationId: getKnowledgeSyncJob
      summary: Get sync job
      description: 'Get one recurring knowledge sync/scan job and run history.


        Required scope: `knowledge:read`.


        On success, `data` contains: `syncJob`.'
      tags:
      - Knowledge Sync Jobs
      security:
      - bearerAuth:
        - knowledge:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - knowledge:read
      x-mint:
        title: Get sync job
        description: Get one recurring knowledge sync/scan job and run history.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        description: Knowledge sync (ingest) job 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:
                      syncJob:
                        $ref: '#/components/schemas/IngestJob'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  syncJob:
                    id: job-id
                    source: SITEMAP
                    syncFrequency: WEEKLY
                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: updateKnowledgeSyncJob
      summary: Update sync job
      description: 'Update auto-sync or sitemap auto-scan frequency for a recurring knowledge job.


        Required scope: `knowledge:write`.


        On success, `data` contains: `syncJob`, `requested`, `effective`.'
      tags:
      - Knowledge Sync Jobs
      security:
      - bearerAuth:
        - knowledge:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - knowledge:write
      x-mint:
        title: Update sync job
        description: Update auto-sync or sitemap auto-scan frequency for a recurring knowledge job.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        description: Knowledge sync (ingest) job ID.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                syncFrequency:
                  type: string
                  enum:
                  - NEVER
                  - DAILY
                  - WEEKLY
                  - MONTHLY
                  default: NEVER
                  description: Only accepted for sitemap, website, and GitHub jobs; other sources are rejected with SYNC_FREQUENCY_UNSUPPORTED_SOURCE.
                scanFrequency:
                  type: string
                  enum:
                  - NEVER
                  - DAILY
                  - WEEKLY
                  - MONTHLY
                  default: NEVER
      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:
                      syncJob:
                        $ref: '#/components/schemas/IngestJob'
                      requested:
                        $ref: '#/components/schemas/GenericObject'
                        description: Requested sync and scan frequencies.
                      effective:
                        $ref: '#/components/schemas/GenericObject'
                        description: Effective frequencies after plan clamping.
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  syncJob:
                    id: job-id
                    source: SITEMAP
                    syncFrequency: WEEKLY
                  requested:
                    syncFrequency: WEEKLY
                    scanFrequency: null
                  effective:
                    syncFrequency: WEEKLY
                    scanFrequency: 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'
    delete:
      operationId: deleteKnowledgeSyncJob
      summary: Delete sync job
      description: 'Disable/delete a recurring knowledge sync/scan job. Existing documents are not deleted. Requires confirm=true.


        Required scope: `knowledge:write`.


        On success, `data` contains: `syncJob`, `message`.'
      tags:
      - Knowledge Sync Jobs
      security:
      - bearerAuth:
        - knowledge:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - knowledge:write
      x-mint:
        title: Delete sync job
        description: Disable/delete a recurring knowledge sync/scan job. Existing documents are not deleted. Requires confirm=true.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        description: Knowledge sync (ingest) job ID.
        schema:
          type: string
      - name: confirm
        in: query
        required: false
        description: Required true for destructive actions.
        schema:
          type: boolean
      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:
                      syncJob:
                        $ref: '#/components/schemas/IngestJob'
                      message:
                        type: string
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  syncJob:
                    id: job-id
                    source: SITEMAP
                    syncFrequency: NEVER
                  message: Sync job disabled. Existing knowledge documents were not deleted.
                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:
    IngestJobRun:
      type: object
      description: One run of a knowledge sync job.
      additionalProperties: true
      properties:
        id:
          type: string
        status:
          type: string
        errorMessage:
          type:
          - string
          - 'null'
        tenantId:
          type:
          - string
          - 'null'
        documentStatsByStatus:
          type: array
          items:
            type: object
            additionalProperties: false
            properties:
              status:
                type: string
              count:
                type: integer
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
    GenericObject:
      type: object
      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
    AgentResponseMeta:
      type: object
      required:
      - requestId
      properties:
        requestId:
          type: string
        warnings:
          type: array
          items:
            type: string
        nextCursor:
          type:
          - string
          - 'null'
      additionalProperties: true
    IngestJob:
      type: object
      description: A knowledge sync job. List responses add run summaries; single reads add the full run list.
      additionalProperties: true
      properties:
        id:
          type: string
        source:
          type: string
        ingestConfig:
          $ref: '#/components/schemas/GenericObject'
          description: Ingestion configuration; request headers are redacted.
        syncFrequency:
          type: string
        scanFrequency:
          type:
          - string
          - 'null'
        tenantId:
          type:
          - string
          - 'null'
        totalIngestJobRuns:
          type:
          - integer
          - 'null'
          description: List responses only.
        latestIngestJobRun:
          anyOf:
          - $ref: '#/components/schemas/IngestJobRun'
          - type: 'null'
        ingestJobRuns:
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/IngestJobRun'
            - type: 'null'
          description: Single-job reads only.
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
    Pagination:
      type: object
      description: Cursor pagination state for paginated list endpoints.
      additionalProperties: false
      required:
      - limit
      - hasNextPage
      - nextCursor
      properties:
        limit:
          type: integer
          description: Page size used.
        hasNextPage:
          type: boolean
        nextCursor:
          type:
          - string
          - 'null'
          description: Pass as the cursor query parameter to fetch the next page. Null on the last page.
  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