Skip to main content
GET
/
kbs
List knowledge bases
curl --request GET \
  --url https://core.ravenna.ai/api/kbs \
  --header 'x-ravenna-api-token: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "icon": "<string>",
      "color": "tomato",
      "workspaceId": "<string>",
      "ownerId": "<string>",
      "syncState": "Queued",
      "syncError": "<string>",
      "syncProgress": 123,
      "syncFrequency": 123,
      "global": true,
      "queues": [
        {
          "id": "<string>",
          "name": "<string>",
          "emoji": "<string>"
        }
      ],
      "agents": [],
      "kBDocuments": [
        {
          "id": "<string>",
          "name": "<string>",
          "syncState": "Queued",
          "syncError": "<string>",
          "doc_id": "<string>",
          "integration": {
            "app": "CODA",
            "ingestNeeds": "<any>",
            "id": "<string>"
          }
        }
      ],
      "_count": {
        "kBDocuments": 123
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "lastSyncTS": 123,
      "parentId": "<string>",
      "archivedAt": "<string>",
      "parent": {},
      "children": [
        {}
      ]
    }
  ],
  "totalCount": 123,
  "nextCursor": "<string>"
}

Authorizations

x-ravenna-api-token
string
header
required

Query Parameters

createdAt
string | null
queueId
string | null
integration
enum<string>[]
system
boolean
global
boolean
skip
number | null
Required range: x >= 1
offset
number | null
Required range: x >= 0
cursor
string | null
limit
number | null
default:100
Required range: 1 <= x <= 10000
set
string | null
sortBy
string | null
sortDirection
enum<string> | null
Available options:
asc,
desc
groupBy
string | null
groupDirection
enum<string> | null
Available options:
asc,
desc
workspaceId
string | null
filters
string | null
filterGroups
string | null

Response

Successful response

items
object[]
required
totalCount
number
required
nextCursor
string