Skip to main content
GET
/
api
/
v1
/
knowledge-base
List Knowledge Bases
curl --request GET \
  --url https://api.voicebot.studio/api/v1/knowledge-base \
  --header 'X-API-Key: <api-key>'
[
  {
    "provider": "trieve",
    "name": "<string>",
    "searchPlan": {
      "removeStopWords": true,
      "scoreThreshold": 123,
      "searchType": "fulltext"
    },
    "createPlan": {
      "type": "create",
      "chunkPlans": [
        {
          "fileIds": [
            "<string>"
          ],
          "websites": [
            "<string>"
          ],
          "targetSplitsPerChunk": 123,
          "splitDelimiters": [
            "<string>"
          ],
          "rebalanceChunks": true
        }
      ]
    },
    "id": "<string>",
    "organizationId": "<string>"
  }
]

Authorizations

​
X-API-Key
string
header
required

Response

200 - application/json

Successful Response

​
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.

​
organizationId
string
required

This is the org id of the knowledge base.

​
name
string | null

This is the name of the knowledge base.

​
searchPlan
object | null

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
object | null

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