v2

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

Retrieve Knowledge Source

Fetch detailed information about a specific knowledge source by its ID. This returns the complete knowledge source object including processing status, source details, and configuration information.

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

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"
}