PIpipeshub-ai
Knowledge Base

Get knowledge base by ID

Changed on

Retrieve detailed information about a specific knowledge base.

Overview:

Returns complete KB metadata including name, timestamps, every folder (nested ones included, without their parent), and the requesting user's role.

Access Control:

User must have at least READER permission to view KB details. A knowledge base the caller holds no role on is answered 404 with the same message as an unknown id, so its existence is not revealed.

Request: only the kbId path parameter is read; any query string or body is ignored.

get/knowledgeBase/{kbId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/{kbId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:read

Path parameters

kbIdstring required
Example:8a095180-2989-4018-b448-70eb75fba1c7

Knowledge base ID (non-empty string). It is not checked to be a UUID: any other value is looked up and answered 404.

Response

Knowledge base retrieved successfully

idstring required

Knowledge base ID

namestring required

Knowledge base name

connectorIdstring nullable required

Associated connector ID (null for manual KBs)

createdAtTimestampinteger required

Creation timestamp in milliseconds

updatedAtTimestampinteger required

Last update timestamp in milliseconds

createdBystring required

User ID of the creator

userRole'OWNER' | 'WRITER' | 'READER' required

User's role in this knowledge base

status'IDLE' | 'QUEUED' | 'SYNCING' | 'FULL_SYNCING' | 'DELETING' nullable

DELETING while the knowledge base is being deleted: reads work, every write is refused with 409 (error.code HTTP_KB_BEING_DELETED), and deleting it again finishes the job. Otherwise its processing state (IDLE, QUEUED, SYNCING, FULL_SYNCING), or null before it is first processed.

Changes

  • dbb5e203b445Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • bb0c59adf026Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status