Sign in

v2

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-07132063.9 KB
Knowledge

Update Knowledge Source

Partially update mutable fields of an existing knowledge source such as name, description, tags, or source-specific configuration. Only the fields provided in the request body will be updated. Some changes (e.g., KnowledgeSourceTypes) may trigger asynchronous reprocessing of the underlying content. Fields omitted from the request remain unchanged. Immutable fields (id, type, status, url, createdAt, updatedAt) cannot be modified directly.

Refresh

To request reprocessing without changing fields, pass the query parameter refresh=true. When refresh=true is provided, the server will re-queue processing for this knowledge resource (transitioning the persisted status to QUEUED) and return 202 Accepted. This query parameter is idempotent while the resource is already QUEUED or PROCESSING.

patch/v2/KnowledgeBases/{kbId}/Knowledge/{knowledgeId}

Query parameters

refreshboolean

When true, re-queues processing for this knowledge resource. Idempotent while the resource is already QUEUED or PROCESSING.

Request body

namestring required

The name of the knowledge source.

descriptionstring

A detailed description of the knowledge source and when to use it. This helps provide context about the content and its intended purpose.

Example request

{
  "name": "Company FAQ Knowledge Base",
  "source": {
    "type": "Text",
    "content": "This is the raw text content that will be processed as knowledge."
  }
}

Response

OK

namestring required

The name of the knowledge source.

descriptionstring

A detailed description of the knowledge source and when to use it. This helps provide context about the content and its intended purpose.

idstring required

The unique identifier of knowledge source.

status'SCHEDULED' | 'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

The status of processing the knowledge source ('SCHEDULED', 'QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED').

createdAtstring date-time required

The date and time in GMT when the Knowledge was created specified in ISO 8601 format.

updatedAtstring date-time required

The date and time in GMT when the Knowledge was last updated specified in ISO 8601 format.

Example response

{
  "id": "know_knowledge_00000000000000000000000000",
  "name": "Company FAQ Knowledge Base",
  "description": "Frequently asked questions and answers for customer support",
  "status": "COMPLETED",
  "source": {
    "type": "Web",
    "url": "https://example.com/faq",
    "crawlDepth": 2,
    "crawlPeriod": "NEVER"
  },
  "createdAt": "2026-01-15T10:30:00Z",
  "updatedAt": "2026-01-15T11:45:00Z"
}