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"
      ],
      "settings_": {
        "allowed_sources": [
          "Document",
          "Google Drive",
          "OneDrive",
          "Website"
        ],
        "ingestion": {
          "batch_size": 8,
          "default_chunk_size": 1024,
          "default_chunk_overlap": 256,
          "enrich_chunks_mode": "inject_summary",
          "enrich_pre_made_qa": false,
          "methods": {
            "application/pdf": {
              "chunk_overlap": 256,
              "chunk_size": 1024,
              "enrich_chunks_mode": "inject_summary",
              "extract_images": true,
              "extract_qa_pairs": false,
              "supported_mime_types": [
                "application/pdf",
                "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                "application/vnd.openxmlformats-officedocument.presentationml.presentation",
                "application/msword",
                "application/vnd.ms-powerpoint"
              ],
              "type": "pdf"
            },
            "default": {
              "chunk_size": 1024,
              "chunk_overlap": 256,
              "enrich_chunks_mode": "inject_summary",
              "extract_qa_pairs": false,
              "type": "default",
              "supported_mime_types": [
                "text/plain",
                "text/html",
                "text/markdown",
                "application/json"
              ]
            },
            "image/*": {
              "supported_mime_types": [
                "image/jpeg",
                "image/png",
                "image/bmp"
              ],
              "type": "image"
            },
            "text/html": {
              "chunk_overlap": 256,
              "chunk_size": 1024,
              "enrich_chunks_mode": "inject_summary",
              "extract_qa_pairs": false,
              "extract_text_only": true,
              "include_images": false,
              "include_tables": true,
              "supported_mime_types": [
                "text/html"
              ],
              "type": "html"
            },
            "text/plain": {
              "chunk_overlap": 256,
              "chunk_size": 1024,
              "chunking": true,
              "enrich_chunks_mode": "inject_summary",
              "extract_qa_pairs": false,
              "preserve_formatting": true,
              "supported_mime_types": [
                "text/plain",
                "text/html",
                "text/markdown",
                "application/json"
              ],
              "type": "text"
            }
          }
        },
        "retrieval": {
          "type": "<string>"
        },
        "embeddings": {
          "text_model": "vertexai/text-multilingual-embedding-002",
          "mm_model": "vertexai/multimodalembedding@001"
        }
      }
    }
  ],
  "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 | null
required
Required range: x >= 0
​
page
integer | null
required
Required range: x >= 1
​
size
integer | null
required
Required range: x >= 1
​
pages
integer | null
Required range: x >= 0