Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Knowledge Bases

List knowledge base sources

Lists all sources (files, URLs, web pages) in a knowledge base. Requires a USER API key.

get/public/v1/knowledge-bases/{knowledgeBaseId}/sources

Path parameters

knowledgeBaseIdinteger required
Example:12

Query parameters

filterTextstring
Example:example
status'NONE' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'DELETING' | 'DELETED' | 'SYNCING' | 'REJECTED'
Example:NONE
sourceType'UNKNOWN' | 'FILE' | 'URL' | 'ARTICLE' | 'QNA' | 'WEBPAGE' | 'FOLDER'
Example:UNKNOWN
fileTypesstring
Example:example

Response

Paginated sources

countnumber
pageSizenumber required
pageNumnumber
totalPagesnumber
cursornumber
paginationType'offset' | 'cursor'

Example response

{
  "count": 1,
  "pageSize": 1,
  "pageNum": 1,
  "totalPages": 1,
  "cursor": 1,
  "results": [
    {
      "id": 1,
      "externalId": "example",
      "knowledgeBaseId": 1,
      "name": "example",
      "description": "example",
      "url": "example",
      "sourceType": "UNKNOWN",
      "websiteSourceId": 1,
      "autoSyncFrequency": "NONE",
      "status": "NONE",
      "charactersCount": 1,
      "ingestJobRunId": "example",
      "fileExtensionType": "UNKNOWN",
      "createdAt": "example",
      "updatedAt": "example",
      "lastSyncedAt": "example",
      "folderId": 1,
      "parsedTextFileUrl": "example",
      "parsedText": "example",
      "websiteSource": {
        "id": 1,
        "name": "example",
        "sourceUrl": "example",
        "websiteType": "WEBSITE_CRAWL",
        "status": "PROCESSING",
        "autoSyncFrequency": "NONE",
        "lastSyncedAt": "example",
        "webPages": 1,
        "_count": {
          "webPages": 1
        }
      },
      "addedByUser": {
        "id": 1,
        "firstName": "example",
        "lastName": "example",
        "avatar": "example"
      },
      "scrapeOptions": {
        "includeSelectors": [
          "example"
        ],
        "excludeSelectors": [
          "example"
        ]
      }
    }
  ],
  "paginationType": "offset",
  "nextCursor": "example"
}