knowledge-bases

Create a new knowledge base

Changed on
post/knowledge-bases

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

ownerType'personal' | 'workspace' required
workspaceIdstring uuid
namestring required

The name of the knowledge base

descriptionstring

An optional description of the knowledge base

Example request

{
  "name": "Stadtratsprotokolle 2025",
  "description": "Sammlung aller Stadtratsprotokolle aus dem Jahr 2025"
}

Response

The knowledge base has been successfully created

idstring uuid required

The unique identifier of the knowledge base

ownerType'personal' | 'workspace' required
workspaceIdstring uuid

The owning workspace for workspace-owned knowledge bases

namestring required

The name of the knowledge base

descriptionstring required

The description of the knowledge base

createdAtstring date-time required

The date and time when the knowledge base was created

updatedAtstring date-time required

The date and time when the knowledge base was last updated

documentCountnumber required

Number of documents assigned to the knowledge base

isActiveboolean required

Whether the knowledge base is active for the current user

isSharedboolean

Whether the knowledge base is shared with the current user (not owned). Only present when relevant (e.g., listing user knowledge bases).

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Stadtratsprotokolle 2025",
  "description": "Sammlung aller Stadtratsprotokolle aus dem Jahr 2025",
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-01-15T10:00:00.000Z",
  "documentCount": 3,
  "isActive": true
}

Changes

  • 2356d2adb113Revision changes
    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 0af97900dc8bRevision changes
    • info

      added the required property to the response with the status