Skip to main content
GET
/
knowledge-base
List Knowledge Bases
curl --request GET \
  --url https://api.cozmox.ai/knowledge-base \
  --header 'Authorization: Bearer <token>'
[
  {
    "provider": "trieve",
    "id": "<string>",
    "orgId": "<string>",
    "name": "<string>",
    "searchPlan": {
      "searchType": "fulltext",
      "topK": 123,
      "removeStopWords": true,
      "scoreThreshold": 123
    },
    "createPlan": {
      "type": "import",
      "providerId": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard.

Query Parameters

​
limit
number

This is the maximum number of items to return. Defaults to 100.

Required range: 0 <= x <= 1000
​
createdAtGt
string<date-time>

This will return items where the createdAt is greater than the specified value.

​
createdAtLt
string<date-time>

This will return items where the createdAt is less than the specified value.

​
createdAtGe
string<date-time>

This will return items where the createdAt is greater than or equal to the specified value.

​
createdAtLe
string<date-time>

This will return items where the createdAt is less than or equal to the specified value.

​
updatedAtGt
string<date-time>

This will return items where the updatedAt is greater than the specified value.

​
updatedAtLt
string<date-time>

This will return items where the updatedAt is less than the specified value.

​
updatedAtGe
string<date-time>

This will return items where the updatedAt is greater than or equal to the specified value.

​
updatedAtLe
string<date-time>

This will return items where the updatedAt is less than or equal to the specified value.

Response

200 - application/json
  • TrieveKnowledgeBase
  • CustomKnowledgeBase
​
provider
enum<string>
required

This knowledge base is provided by Trieve.

To learn more about Trieve, visit https://trieve.ai.

Available options:
trieve
​
id
string
required

This is the id of the knowledge base.

​
orgId
string
required

This is the org id of the knowledge base.

​
name
string

This is the name of the knowledge base.

​
searchPlan
object

This is the searching plan used when searching for relevant chunks from the vector store.

You should configure this if you're running into these issues:

  • Too much unnecessary context is being fed as knowledge base context.
  • Not enough relevant context is being fed as knowledge base context.
​
createPlan
Import · object

This is the plan if you want us to create/import a new vector store using Trieve.