Skip to main content
GET
List knowledge bases

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Query Parameters

flat
enum<string>

true lists every knowledge base, whatever folder it's in. Without it, the first page also includes the level's folders ahead of the knowledge bases.

Available options:
true,
false
page
integer
default:1
Required range: x >= 1
perPage
integer
default:15
Required range: 1 <= x <= 100

Case-insensitive match on the name or knowledgeId.

type
enum<string>

Only these types. Repeat it for several.

Available options:
pdf,
txt,
csv,
json,
docx,
md,
url
status
enum<string>

Only these statuses. Repeat it for several.

Available options:
processing,
ready,
failed
folderId
string

List this folder's contents.

Response

A page of knowledge bases.

data
object[]
pageInfo
object