> ## 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.

# Get sync job

> Get one recurring knowledge sync/scan job and run history.

Required scope: `knowledge:read`.

On success, `data` contains: `syncJob`.



## OpenAPI

````yaml https://sitegpt.ai/api/v2/openapi.json get /api/v2/chatbots/{chatbotId}/ingest-jobs/{jobId}
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}/ingest-jobs/{jobId}:
    get:
      tags:
        - Knowledge Sync Jobs
      summary: Get sync job
      description: |-
        Get one recurring knowledge sync/scan job and run history.

        Required scope: `knowledge:read`.

        On success, `data` contains: `syncJob`.
      operationId: getKnowledgeSyncJob
      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'
      security:
        - bearerAuth:
            - knowledge:read
components:
  schemas:
    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
    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
    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
    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

````