v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Knowledge Bases

Get website crawl sync history

Lists sync summaries (crawl runs) for a website source. Requires a USER API key.

get/public/v1/knowledge-bases/{knowledgeBaseId}/website-crawls/{websiteSourceId}/sync-history

Path parameters

knowledgeBaseIdinteger required

Example:12

websiteSourceIdinteger required

Example:88

Query parameters

syncType'INITIAL_SYNC' | 'MANUAL_RESYNC' | 'AUTO_RESYNC'

Example:INITIAL_SYNC

Example:PROCESSING

pageSizenumber

Example:1

pageNumnumber

Example:1

number nullable

string

object nullable

Example:1

Response

Paginated sync summaries

countnumber

pageSizenumber required

pageNumnumber

totalPagesnumber

cursornumber

paginationType'offset' | 'cursor'

Example response

{
  "count": 1,
  "pageSize": 1,
  "pageNum": 1,
  "totalPages": 1,
  "cursor": 1,
  "results": [
    {
      "id": 1,
      "syncType": "INITIAL_SYNC",
      "status": "PROCESSING",
      "startedAt": "example",
      "finishedAt": "example",
      "duration": 1,
      "syncedPages": 1,
      "failedPages": 1,
      "rejectedPages": 1,
      "removedPages": 1,
      "totalPages": 1,
      "errorMessage": "example",
      "ingestJobRunId": "example",
      "websiteSourceId": 1,
      "knowledgeBaseId": 1,
      "triggeredByUserId": 1,
      "websiteSource": {
        "id": 1,
        "name": "example",
        "sourceUrl": "example",
        "websiteType": "WEBSITE_CRAWL"
      },
      "triggeredByUser": {
        "id": 1,
        "firstName": "example",
        "lastName": "example",
        "avatar": "example"
      },
      "createdAt": "example",
      "updatedAt": "example"
    }
  ],
  "paginationType": "offset",
  "nextCursor": "example"
}