Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Knowledge Bases

Add URL sources

Adds one or more URL sources to a knowledge base. The URLs are fetched and indexed asynchronously. Requires a USER API key.

post/public/v1/knowledge-bases/{knowledgeBaseId}/sources/urls

Path parameters

knowledgeBaseIdinteger required
Example:12

Request body

urlsstring[] required
descriptionstring
type'UNKNOWN' | 'FILE' | 'URL' | 'ARTICLE' | 'QNA' | 'WEBPAGE' | 'FOLDER'
autoSyncFrequency'NONE' | 'DAILY' | 'WEEKLY' | 'MONTHLY'

Example request

{
  "urls": [
    "https://api.example.com/contacts/123"
  ],
  "description": "example",
  "type": "UNKNOWN",
  "autoSyncFrequency": "NONE",
  "scrapeOptions": {
    "includeSelectors": [
      "example"
    ],
    "excludeSelectors": [
      "example"
    ]
  }
}

Response

Created sources

idnumber required
externalIdstring nullable required
knowledgeBaseIdnumber required
namestring required
descriptionstring nullable required
urlstring nullable required
sourceType'UNKNOWN' | 'FILE' | 'URL' | 'ARTICLE' | 'QNA' | 'WEBPAGE' | 'FOLDER' required
websiteSourceIdnumber nullable required
autoSyncFrequency'NONE' | 'DAILY' | 'WEEKLY' | 'MONTHLY' required
status'NONE' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'DELETING' | 'DELETED' | 'SYNCING' | 'REJECTED' required
charactersCountnumber required
ingestJobRunIdstring nullable required
fileExtensionType'UNKNOWN' | 'PDF' | 'DOC' | 'DOCX' | 'TXT' | 'CSV' | 'JSON' | 'MD' | 'HTML' nullable required
createdAtstring required
updatedAtstring required
lastSyncedAtstring nullable required
folderIdnumber nullable required
parsedTextFileUrlstring nullable required
parsedTextstring nullable

Example response

[
  {
    "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"
      ]
    }
  }
]