Knowledge Base

Get knowledge base upload limits

Changed on

Retrieve current upload constraints for the organization.

Use case: Call this before uploads to validate file sizes on the client side and display appropriate limits to users.

maxFilesPerRequest is a fixed 1000. maxFileSizeBytes is the organization's fileUploadMaxSizeBytes platform setting, read on every call (30 MB when the setting cannot be read). Any signed-in member gets the same values; no knowledge base role is needed.

Request: there is no validator and nothing from the request is read; any query string is ignored.

get/knowledgeBase/limits

Request

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

Response

Upload limits retrieved

maxFilesPerRequestinteger required

Maximum number of files per upload request

maxFileSizeBytesinteger required

Maximum file size in bytes (default 30MB when platform settings unavailable)

Example response

{
  "maxFilesPerRequest": 1000,
  "maxFileSizeBytes": 31457280
}

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status