Skip to content

List knowledge bases

GET
/knowledge-bases
knowledgeBaseIds

Comma-separated list of knowledge base IDs to filter by

string
nullable

Comma-separated list of knowledge base IDs to filter by

teamIds

Comma-separated list of team IDs to filter by

string
nullable

Comma-separated list of team IDs to filter by

name

Filter knowledge bases by name (partial match)

string

Filter knowledge bases by name (partial match)

page

Page number for pagination (1-indexed)

number
>= 1

Page number for pagination (1-indexed)

pageSize

Number of results per page (1-100, default: 20)

number
>= 1 <= 100

Number of results per page (1-100, default: 20)

orderBy

Field to sort results by

string
Allowed values: createdAt name updatedAt

Field to sort results by

orderDirection

Sort direction: ascending or descending

string
Allowed values: asc desc

Sort direction: ascending or descending

Knowledge bases retrieved successfully

object
knowledgeBases
required

Array of knowledge bases matching the query

Array<object>
object
knowledgeBaseId
required

Unique identifier for the knowledge base (nanoid format)

string
teamId
required

ID of the team that owns this knowledge base

string
name
required

Human-readable name for the knowledge base

string
config
required

Configuration settings

object
embeddingModels
required

List of embedding models configured for this knowledge base

Array<string>
Allowed values: BAAI/bge-small-en-v1.5 BAAI/bge-base-en-v1.5 BAAI/bge-large-en-v1.5 sentence-transformers/all-MiniLM-L6-v2 sentence-transformers/all-mpnet-base-v2 nomic-ai/nomic-embed-text-v1.5
primaryEmbeddingModel
required

Primary embedding model used for queries when model is not specified

string
Allowed values: BAAI/bge-small-en-v1.5 BAAI/bge-base-en-v1.5 BAAI/bge-large-en-v1.5 sentence-transformers/all-MiniLM-L6-v2 sentence-transformers/all-mpnet-base-v2 nomic-ai/nomic-embed-text-v1.5
chunkSize
required

Token count per chunk

integer
chunkOverlap
required

Token overlap between chunks

integer
nlpLibrary
required

NLP library for concept extraction

string
communitiesStale
required

Whether communities need to be rebuilt due to content changes

boolean
communitiesBuiltAt
required

ISO 8601 timestamp when communities were last built

string format: date-time
nullable
createdAt
required

ISO 8601 timestamp when the knowledge base was created

string format: date-time
updatedAt
required

ISO 8601 timestamp when the knowledge base was last modified

string format: date-time
total
required

Total number of knowledge bases matching the query (before pagination)

number
page
required

Current page number

number
pageSize
required

Number of results per page

number

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean