Skip to main content
GET
/
list-knowledge-bases
JavaScript
import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted
});

const knowledgeBaseResponses = await client.knowledgeBase.list();

console.log(knowledgeBaseResponses);
[
  {
    "knowledge_base_id": "knowledge_base_a456426614174000",
    "knowledge_base_name": "Sample KB",
    "status": "in_progress",
    "max_chunk_size": 2000,
    "min_chunk_size": 400,
    "knowledge_base_sources": [
      {
        "type": "document",
        "source_id": "<string>",
        "filename": "<string>",
        "file_url": "<string>"
      }
    ],
    "enable_auto_refresh": true,
    "last_refreshed_timestamp": 1703413636133
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.retellai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Response

Successfully retrieved all knowledge bases.

​
knowledge_base_id
string
required

Unique id of the knowledge base.

Example:

"knowledge_base_a456426614174000"

​
knowledge_base_name
string
required

Name of the knowledge base. Must be less than 40 characters.

Example:

"Sample KB"

​
status
enum<string>
required

Status of the knowledge base. When it's created and being processed, it's "in_progress". When the processing is done, it's "complete". When there's an error in processing, it's "error". When it is during kb updating, it's "refreshing_in_progress".

Available options:
in_progress,
complete,
error,
refreshing_in_progress
Example:

"in_progress"

​
max_chunk_size
integer

Maximum number of characters per chunk when splitting knowledge base content.

Example:

2000

​
min_chunk_size
integer

Minimum number of characters per chunk. Chunks smaller than this are merged with adjacent chunks.

Example:

400

​
knowledge_base_sources
object[]

Sources of the knowledge base. Will be populated after the processing is done (when status is "complete").

​
enable_auto_refresh
boolean

Whether to enable auto refresh for the knowledge base urls. If set to true, will retrieve the data from the specified url every 12 hours.

Example:

true

​
last_refreshed_timestamp
integer

Last refreshed timestamp (milliseconds since epoch). Only applicable when enable_auto_refresh is true.

Example:

1703413636133