Overview
Retrieve the complete information for a specific Knowledge Base using its unique ID. This endpoint returns the Knowledge Base metadata, document information, and configuration used by your AI agents.Prerequisites
- Bearer token for an authenticated workspace
- Valid Knowledge Base ID
Request
string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the Knowledge Base.
Response
Response Fields
boolean
Indicates whether the request completed successfully.
integer
HTTP status code.
string
Response message.
object
Knowledge Base information.
string
Unique identifier of the Knowledge Base.
string
Name of the Knowledge Base.
string
Description of the Knowledge Base.
array
List of uploaded documents associated with this Knowledge Base.
string
Uploaded document name.
string
Public or signed URL of the uploaded document.
string
Timestamp when the document was uploaded.
string
Knowledge Base creation timestamp.
string
Last updated timestamp.
Error Handling
Use this endpoint whenever you need the complete metadata of a Knowledge Base before updating it, attaching it to an AI agent, or managing its documents.
Common next steps:
PUT /api/knowledgeBase/{knowledgeBaseId}— Update the Knowledge Base.GET /api/knowledgeBase/{knowledgeBaseId}/documents— List all documents.DELETE /api/knowledgeBase/{knowledgeBaseId}— Delete the Knowledge Base.