Skip to main content
GET
/
api
/
knowledge-bases
/
list-knowledge-bases
List knowledge bases
curl --request GET \
  --url http://localhost:8080/api/knowledge-bases/list-knowledge-bases \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>'
{
  "message": "Knowledge bases retrieved successfully",
  "status": "success",
  "error": null,
  "data": {
    "organization_id": "your-org-id",
    "knowledge_bases": [
      {
        "knowledge_base_id": "knowledge_base_abc123",
        "knowledge_base_name": "Customer Support KB",
        "status": "ready",
        "enable_auto_refresh": true,
        "last_refreshed_timestamp": 1704067200000,
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z"
      }
    ],
    "returned_count": 1,
    "pagination": {
      "page": 0,
      "limit": 10,
      "total_pages": 1,
      "total_count": 1,
      "has_next": false,
      "has_previous": false
    },
    "sort_order": "descending",
    "sort_by": "updated_at",
    "applied_filters": {
      "name": "Customer"
    }
  }
}

Authorizations

X-API-KEY
string
header
required

API Key for MCP server and external service authentication

X-API-SECRET
string
header
required

API Secret for MCP server and external service authentication

Query Parameters

limit
integer<int32>

Number of results per page

Example:

10

page
integer<int32>

Page number (0-based)

Example:

0

sort_order
string

Sort direction: ascending or descending

Example:

"descending"

sort_by
string

Sort field: updated_at, created_at, knowledge_base_name, status

Example:

"updated_at"

name
string

Filter by knowledge base name

Example:

"Customer"

Response

Knowledge bases retrieved successfully

message
string
status
string
error
string | null
data
object