Skip to main content
GET
Return a list of Knowledge Base Items.

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

voiceAgentId
string

Optional UUID of the voice agent to filter associated knowledge bases items.

Example:

"d949f13f-40d2-4e48-ac86-b66633070603"

isActive
boolean

Optional boolean indicating whether to fetch active knowledge base items.

Example:

true

used
string

Optional boolean-like string indicating whether to fetch used knowledge base items in any voice agent.

Example:

"true"

skip
string

Page number for pagination. Defaults to '1'.

Example:

"1"

take
string

Number of items to take for pagination. Defaults to '10'.

Example:

"10"

A search query to filter knowledge base items' names.

Example:

"Product Catalog"

type
enum<string>[]

An array of knowledge base item type to filter by.

Available options:
TEXT,
URL,
FILE
Example:
status
enum<string>[]

An array of knowledge base item status to filter by.

Available options:
PROCESSED,
FAILED,
COMPLETED_WITH_ERRORS,
UPLOAD_FAILURE,
READING_FAILURE,
INGESTION_FAILURE
Example:
extensions
enum<string>[]

An array of knowledge base item extensions to filter by when the type is FILE.

Available options:
pdf,
docx,
doc,
txt,
html,
epub
Example:
sortField
enum<string>

The field name to sort the results by

Available options:
words,
createdAt,
fileSize
Example:

"createdAt"

sortOrder
enum<string>

Sort order. Can be 'asc' or 'desc'.

Available options:
asc,
desc
Example:

"asc"

Response

Successful response

success
boolean
default:false
message
string
default:success
data
object