Skip to main content
GET
List Knowledge Bases
Read only
v1 only. Knowledge bases are available on the /v1 API. There is no legacy unversioned equivalent.
Return all knowledge bases that belong to the authenticated workspace. Use this to populate a picker in your own UI, or to find the id of a knowledge base before attaching it to an agent.

When to use this

  • Pickers: list the knowledge bases an operator can attach to an agent.
  • ID lookup: find the kb_ ID by name before passing it in knowledge_base_ids on Create Agent or Update Agent.
  • Housekeeping: audit which knowledge bases exist before creating a new one, since names must be unique within a workspace.
The response contains an items array and a meta object with totalItems, itemsPerPage, totalPages, and currentPage. The endpoint accepts page, limit, sortBy, and sortOrder; see Pagination for iteration examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
number
Example:

1

limit
number
Example:

20

sortBy
string
Example:

"id"

sortOrder
enum<string>
Available options:
ASC,
DESC

Response

Knowledge bases returned successfully.

items
object[]
required
meta
object
required