Skip to main content
Fetch Knowledge-Bases
curl --request GET \
  --url https://{api_endpoint}/api/v1/orchestrate/knowledge-bases \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "prioritize_built_in_index": true,
    "created_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "representation": "auto",
    "vector_index": {
      "embeddings_model_name": "<string>",
      "chunk_size": 123,
      "chunk_overlap": 123,
      "status": "not_ready",
      "status_msg": "<string>",
      "top_k": 10,
      "extraction_strategy": "standard"
    },
    "conversational_search_tool": {
      "language": "en",
      "index_config": [
        {
          "connection_id": "<string>",
          "milvus": {
            "grpc_host": "<string>",
            "database": "<string>",
            "collection": "<string>",
            "index": "<string>",
            "embedding_model_id": "<string>",
            "grpc_port": "<string>",
            "server_cert": "<string>",
            "limit": 10,
            "filter": "<string>",
            "field_mapping": {
              "title": "title",
              "body": "text",
              "url": "<string>"
            }
          },
          "elastic_search": {
            "url": "<string>",
            "index": "<string>",
            "port": "<string>",
            "query_body": {},
            "result_filter": [
              "<unknown>"
            ],
            "field_mapping": {
              "title": "title",
              "body": "text",
              "url": "<string>"
            }
          },
          "custom_search": {
            "url": "<string>",
            "filter": "<string>",
            "metadata": {}
          },
          "astradb": {
            "api_endpoint": "<string>",
            "port": "<string>",
            "server_cert": "<string>",
            "keyspace": "<string>",
            "data_type": "collection",
            "collection": "<string>",
            "table": "<string>",
            "index_column": "<string>",
            "embedding_mode": "server",
            "embedding_model_id": "<string>",
            "search_mode": "vector",
            "limit": 5,
            "filter": "<string>",
            "field_mapping": {
              "title": "title",
              "body": "text",
              "url": "<string>"
            }
          }
        }
      ],
      "generation": {
        "model_id": "<string>",
        "prompt_instruction": "",
        "max_docs_passed_to_llm": 5,
        "generated_response_length": "Moderate",
        "display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
        "display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
        "idk_message": "I'm afraid I don't understand. Please rephrase your question.",
        "enabled": true
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "<string>"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Lowest",
        "response_confidence_threshold": "Lowest"
      },
      "citations": {
        "citation_title": "How do we know?",
        "citations_shown": -1
      },
      "hap_filtering": {
        "output": {
          "enabled": false,
          "threshold": 0.5
        }
      },
      "query_source": "SessionHistory",
      "agent_query_description": "The query to search for in the knowledge base",
      "supports_full_document": false
    }
  }
]

Authorizations

Authorization
string
header
required

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

Query Parameters

names
string[] | null
ids
string[] | null
query
string | null

Search by name and description

limit
integer | null

Limit the number of results returned

Required range: x >= 1
offset
integer | null
default:0

Skip the first N results

Required range: x >= 0
sort
enum<string> | null
default:asc

Sort by name and recently added (recent/asc/desc)

Available options:
asc,
desc,
recent

Response

Successful Response

id
string<uuid>
required

Unique identifier for the KB

tenant_id
string
required

ID of the tenant that owns this KB

name
string
required

Name of the KB

display_name
string | null
required

Display name of the KB

description
string
required

Description of what the KB contains

prioritize_built_in_index
boolean
required

prioritize built in vector index if both a built in index and external index is provided

created_by
string
required

Username of the user who created the KB

updated_at
string<date-time>
required

Last update timestamp

representation
enum<string>
required
Available options:
auto,
tool
vector_index
VectorIndexOut · object
required
conversational_search_tool
ConversationalSearchConfig · object
required