Skip to main content
GET
/
api
/
knowledge-bases
/
list-knowledge-bases
curl -X GET "https://api.zudu.ai/api/knowledge-bases/list-knowledge-bases?limit=20&page=0&sort_by=created_at&sort_order=desc&name=production" \
  -H "X-API-KEY: sk_Abc123Def456..." \
  -H "X-API-SECRET: s3cr3t_Xyz789..." \

{
  "message": "Knowledge bases retrieved successfully",
  "status": "success",
  "error": null,
  "data": [
    {
      "knowledge_base_id": "kb_abc123...",
      "organization_id": "org_1234567890",
      "knowledge_base_name": "Product Documentation",
      "status": "ACTIVE",
      "enable_auto_refresh": true,
      "last_refreshed_timestamp": 1705320000000,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T11:45:00Z",
      "knowledge_base_sources": [
        {
          "source_id": "src_123...",
          "source_type": "TEXT",
          "title": "Introduction"
        }
      ]
    }
  ]
}
Retrieve a paginated list of knowledge bases for your organization with filtering and sorting capabilities. 
curl -X GET "https://api.zudu.ai/api/knowledge-bases/list-knowledge-bases?limit=20&page=0&sort_by=created_at&sort_order=desc&name=production" \
  -H "X-API-KEY: sk_Abc123Def456..." \
  -H "X-API-SECRET: s3cr3t_Xyz789..." \

{
  "message": "Knowledge bases retrieved successfully",
  "status": "success",
  "error": null,
  "data": [
    {
      "knowledge_base_id": "kb_abc123...",
      "organization_id": "org_1234567890",
      "knowledge_base_name": "Product Documentation",
      "status": "ACTIVE",
      "enable_auto_refresh": true,
      "last_refreshed_timestamp": 1705320000000,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T11:45:00Z",
      "knowledge_base_sources": [
        {
          "source_id": "src_123...",
          "source_type": "TEXT",
          "title": "Introduction"
        }
      ]
    }
  ]
}

​
Headers

​
X-API-KEY
string
required
Your API key (format: sk_...)
​
X-API-SECRET
string
required
Your API secret (format: s3cr3t_...)

​
Query Parameters

​
limit
number
Number of items per page
  • Default: All records if not specified
  • Use with page for pagination
Example: 20
​
page
number
Page number (0-based indexing)
  • Default: 0
  • Requires limit parameter
Example: 0 (first page)
​
sort_by
string
Field to sort byOptions:
  • created_at - Sort by creation date
  • updated_at - Sort by last update date
  • knowledge_base_name - Sort by name
Default: created_at
​
sort_order
string
Sort orderOptions:
  • asc - Ascending order
  • desc - Descending order (default)
Default: desc
​
name
string
Filter by knowledge base name (partial match)Searches for knowledge bases containing this string in the name.Example: "production" or "documentation"

​
Response Fields

​
data
array
Array of knowledge base objects
​
data[].knowledge_base_id
string
Unique identifier for the knowledge base (format: kb_...)
​
data[].organization_id
string
Organization ID the knowledge base belongs to
​
data[].knowledge_base_name
string
Name of the knowledge base
​
data[].status
string
Current status of the knowledge baseOptions:
  • DRAFT - Knowledge base is being created
  • ACTIVE - Knowledge base is active and ready to use
  • PROCESSING - Knowledge base is being processed
​
data[].enable_auto_refresh
boolean
Whether auto-refresh is enabled for URL sources
​
data[].last_refreshed_timestamp
number
Unix timestamp (milliseconds) of last refresh
​
data[].created_at
string
ISO 8601 timestamp when knowledge base was created
​
data[].updated_at
string
ISO 8601 timestamp of last update
​
data[].knowledge_base_sources
array
Array of sources within the knowledge base

​
Error Responses

​
error
string
Unauthorized - Missing or invalid API key/secret
​
error
string
Internal Server Error - Failed to list knowledge bases
{
  "message": "Failed to list knowledge bases",
  "status": "error",
  "error": "Database connection failed"
}

​
Notes

  • Results are automatically scoped to your organization
  • If limit is not provided, all knowledge bases are returned
  • Name filter performs partial matching (case-insensitive)
  • Pagination requires both limit and page parameters
  • Knowledge base sources are included in the response