GET
/
v1
/
knowledge-bases
/
{knowledge_base_id}
{
  "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"
  ]
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
knowledge_base_id
string
required

Response

200
application/json
Successful Response
​
id
string
required
​
group_id
string
required
​
name
string
required
​
status
enum<string>
required
Available options:
created,
trained,
training,
error
​
description
string
required
​
document_types
string[]
required
​
kb_type
enum<string>
required
Available options:
temporary,
entity
​
size
number
required
​
num_docs
integer
required
​
created_at
string
required
​
updated_at
string
required
​
error
object | null
required
​
total_documents
integer
required
​
training_documents
integer
required
​
trained_documents
integer
required
​
error_documents
integer
required
​
uploaded_documents
integer
required
​
source_types
object
required
​
training_source_types
enum<string>[]
required
Available options:
Document,
Google Drive,
Notion,
Website,
OneDrive,
Slack,
Linear,
Github,
Teams,
Sharepoint
Search RunsCreate Knowledge Base