GET
/
v1
/
knowledge-bases
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "created",
      "description": "<string>",
      "document_types": [
        "<string>"
      ],
      "kb_type": "temporary",
      "size": 123,
      "num_docs": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "error": {},
      "total_documents": 123,
      "training_documents": 123,
      "trained_documents": 123,
      "error_documents": 123,
      "uploaded_documents": 123,
      "source_types": {},
      "training_source_types": [
        "Document"
      ]
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
query
string | null
​
order_by
string
default:last_updated_at
​
sort
string
default:desc
​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

200
application/json
Successful Response
​
items
object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
required
Required range: x >= 0
Create Knowledge BaseDelete Knowledge Base