List Knowledge Bases

curl --request GET \
  --url https://api.example.com/api/v1/knowledge-bases

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/knowledge-bases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/knowledge-bases"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/knowledge-bases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "document_language": "en",
      "document_count": 0,
      "chunking_strategy": "recursive",
      "vector_backend": "pinecone",
      "embedding_model": "text-embedding-3-small",
      "chunk_size": 512,
      "chunk_overlap": 50,
      "assistant_persona": "<string>",
      "status": "processing",
      "workspace_id": "<string>",
      "organization_id": "<string>",
      "user_id": "<string>"
    }
  ],
  "next_page_token": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>"
}

GET

api

knowledge-bases

List Knowledge Bases

curl --request GET \
  --url https://api.example.com/api/v1/knowledge-bases

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/knowledge-bases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/knowledge-bases"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/knowledge-bases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "document_language": "en",
      "document_count": 0,
      "chunking_strategy": "recursive",
      "vector_backend": "pinecone",
      "embedding_model": "text-embedding-3-small",
      "chunk_size": 512,
      "chunk_overlap": 50,
      "assistant_persona": "<string>",
      "status": "processing",
      "workspace_id": "<string>",
      "organization_id": "<string>",
      "user_id": "<string>"
    }
  ],
  "next_page_token": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>"
}

Query Parameters

page_token

string | null

Opaque cursor taken from the previous response's next_page_token. Omit for the first page.

limit

integer

default:10

Maximum number of knowledge bases to return.

Required range: 1 <= x <= 100

Response

A page of knowledge bases.

Cursor-paginated list of knowledge bases.

data

KnowledgeBaseResponse · object[]

required

Knowledge bases for the current page.

Show child attributes

next_page_token

string | null

Opaque cursor. Pass it back as the page_token query parameter to fetch the next page. Null means there are no more pages.

API Reference

AI Agents v2

Built-in Tools

Custom Tools

Calls

Call Recording

Post-call Analysis

Phone Numbers

Knowledge Bases

Prompt Generation

Public Sharing

Webhook Subscriptions

API Keys

List Knowledge Bases

Query Parameters

Response