Skip to main content
GET
Get Knowledge Base Details
Read only Fetch one knowledge base by its id. The record carries id, name, org_id, is_deleted, created_at and updated_at.

When to use this

  • Verify before attaching: confirm a knowledge base exists and has the expected name before referencing it in knowledge_base_ids on Create Agent or Update Agent.
  • Detail views: render a knowledge base detail page in your own admin tooling.
A 404 Not Found means the knowledge base does not exist in this workspace, which is also what you get for one that belongs to another workspace. See API errors for the standard error format. The response describes the knowledge base resource record only. To see its documents and whether each one has finished indexing (ingest_status), call List Knowledge Base Documents.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Knowledge base ID

Example:

"kb_abc123"

Response

Knowledge base returned successfully.

success
enum<boolean>
required
Available options:
true
error
enum<boolean>
required
Available options:
false
statusCode
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required
timestamp
string<date-time>
required