Create a new knowledge base
Changed onCreate a new knowledge base for organizing and managing documents within your organization.
Overview:
A knowledge base is a container for organizing related documents, files, and content. It provides a central location for teams to collaborate on shared information.
Features:
- Hierarchical folder structure support
- Role-based access control (OWNER, WRITER, READER)
- Full-text search across all records
- Integration with external connectors (Google Drive, OneDrive, etc.)
- Automatic content indexing for AI-powered search
Naming Rules:
- Name must be 1-255 characters and hold at least one character that is not whitespace
- Whitespace around the name is removed before it is stored
- A name that contains an HTML tag, a javascript: URL or an inline event handler (onclick= and the like) is refused with 400; nothing is stripped out of it
- Names don't need to be unique within organization
Request body:
Only kbName is read. Any other field is dropped before the handler runs, so a knowledge base cannot be created hidden, or with another role or organization, through this endpoint.
Creator Permissions:
The user creating the KB automatically becomes the OWNER with full administrative rights.
Request
- Base URLhttps://app.pipeshub.com/api/v1
- URLhttps://app.pipeshub.com/api/v1/knowledgeBase
- Auth
- HTTP bearer
- or OAuth 2Authorization code: /api/v1/oauth2/authorizeClient credentialsToken URL: /api/v1/oauth2/token scopes: kb:write
Request body
Example request
{
"kbName": "Product Documentation"
}Response
Knowledge base created successfully
Changes
- breaking
added the pattern
\Sto the request property - info
added the media type
application/x-www-form-urlencodedto the request body
- breaking
- 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 - info
added the optional property
/to the response with the status
- info