Get Knowledge Base

GET

datasets

{dataset_id}

Get Knowledge Base

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "app_count": 0,
  "author_name": "admin",
  "built_in_field_enabled": true,
  "chunk_structure": null,
  "created_at": 1741267200,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "data_source_type": null,
  "description": "Technical documentation for the product API",
  "doc_form": "text_model",
  "doc_metadata": [],
  "document_count": 0,
  "embedding_available": true,
  "embedding_model": "text-embedding-3-small",
  "embedding_model_provider": "langgenius/openai/openai",
  "enable_api": true,
  "external_knowledge_info": null,
  "external_retrieval_model": null,
  "icon_info": null,
  "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9",
  "indexing_technique": "high_quality",
  "is_multimodal": false,
  "is_published": false,
  "maintainer": "admin",
  "name": "Product Documentation",
  "permission": "only_me",
  "pipeline_id": null,
  "provider": "vendor",
  "retrieval_model_dict": {
    "reranking_enable": false,
    "reranking_mode": null,
    "reranking_model": {
      "reranking_model_name": "",
      "reranking_provider_name": ""
    },
    "score_threshold": null,
    "score_threshold_enabled": false,
    "search_method": "semantic_search",
    "top_k": 3,
    "weights": null
  },
  "runtime_mode": null,
  "summary_index_setting": null,
  "tags": [],
  "total_available_documents": 0,
  "total_documents": 0,
  "updated_at": 1741267200,
  "updated_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "word_count": 0
}

{
  "code": "forbidden",
  "message": "Dataset api access is not enabled.",
  "status": 403
}

{
  "code": "not_found",
  "message": "Dataset not found.",
  "status": 404
}

Authorizations

Authorization

string

header

required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

dataset_id

string<uuid>

required

Knowledge base ID, from List Knowledge Bases.

Response

Knowledge base details.

app_count

integer

Number of applications currently using this knowledge base.

author_name

string

Display name of the creator.

built_in_field_enabled

boolean

Whether built-in metadata fields (e.g., document_name, uploader) are enabled.

chunk_structure

string | null

Chunk structure configuration.

created_at

number

Creation timestamp (Unix epoch in seconds).

created_by

string

ID of the user who created the knowledge base.

data_source_type

string

Data source type of the documents, null if not yet configured.

description

string

Optional text describing the purpose or contents of the knowledge base.

doc_form

string

Document chunking mode. text_model for standard text chunking, hierarchical_model for parent-child structure, qa_model for QA pair extraction.

doc_metadata

object[]

Metadata field definitions for the knowledge base.

Show child attributes

document_count

integer

Total number of documents in the knowledge base.

embedding_available

boolean

Whether the configured embedding model is currently available.

embedding_model

string

Name of the embedding model used for indexing.

embedding_model_provider

string

Embedding model provider identifier, formatted as organization/plugin_name/provider_name (e.g. langgenius/openai/openai). Legacy knowledge bases may return the bare short form (e.g. openai).

enable_api

boolean

Whether API access is enabled for this knowledge base.

external_knowledge_info

object | null

Connection details for external knowledge bases. Present when provider is external.

Show child attributes

external_retrieval_model

object | null

Retrieval settings for external knowledge bases. null for internal knowledge bases.

Show child attributes

icon_info

object | null

Icon display configuration for the knowledge base.

Show child attributes

string

Unique identifier of the knowledge base.

indexing_technique

string

high_quality uses embedding models for precise search; economy uses keyword-based indexing.

is_multimodal

boolean

Whether multimodal content processing is enabled.

is_published

boolean

Whether the knowledge base is published.

maintainer

string | null

Display name of the knowledge base maintainer. null if not set.

name

string

Display name of the knowledge base. Unique within the workspace.

partial_member_list

string[] | null

Account IDs of members granted access when permission is partial_members. Always present on the update response; on the detail response, present only when permission is partial_members.

permission

string

Controls who can access this knowledge base. Possible values: only_me, all_team_members, partial_members.

pipeline_id

string | null

Pipeline ID, if a custom processing pipeline is configured.

provider

string

Provider type. vendor for internally managed, external for external knowledge base connections.

retrieval_model_dict

object

Retrieval configuration for the knowledge base.

Show child attributes

runtime_mode

string | null

Runtime processing mode.

summary_index_setting

object | null

Summary index configuration.

Show child attributes

tags

object[]

Tags associated with this knowledge base.

Show child attributes

total_available_documents

integer

Number of documents that are enabled and available.

total_documents

integer

Total number of documents.

updated_at

number

Last update timestamp (Unix epoch in seconds).

updated_by

string

ID of the user who last updated the knowledge base.

word_count

integer

Total word count across all documents.

Last modified on September 9, 2026

Get Knowledge Base

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "app_count": 0,
  "author_name": "admin",
  "built_in_field_enabled": true,
  "chunk_structure": null,
  "created_at": 1741267200,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "data_source_type": null,
  "description": "Technical documentation for the product API",
  "doc_form": "text_model",
  "doc_metadata": [],
  "document_count": 0,
  "embedding_available": true,
  "embedding_model": "text-embedding-3-small",
  "embedding_model_provider": "langgenius/openai/openai",
  "enable_api": true,
  "external_knowledge_info": null,
  "external_retrieval_model": null,
  "icon_info": null,
  "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9",
  "indexing_technique": "high_quality",
  "is_multimodal": false,
  "is_published": false,
  "maintainer": "admin",
  "name": "Product Documentation",
  "permission": "only_me",
  "pipeline_id": null,
  "provider": "vendor",
  "retrieval_model_dict": {
    "reranking_enable": false,
    "reranking_mode": null,
    "reranking_model": {
      "reranking_model_name": "",
      "reranking_provider_name": ""
    },
    "score_threshold": null,
    "score_threshold_enabled": false,
    "search_method": "semantic_search",
    "top_k": 3,
    "weights": null
  },
  "runtime_mode": null,
  "summary_index_setting": null,
  "tags": [],
  "total_available_documents": 0,
  "total_documents": 0,
  "updated_at": 1741267200,
  "updated_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "word_count": 0
}

{
  "code": "forbidden",
  "message": "Dataset api access is not enabled.",
  "status": 403
}

{
  "code": "not_found",
  "message": "Dataset not found.",
  "status": 404
}

Guides

App APIs

Knowledge APIs

Get Knowledge Base

Authorizations

Path Parameters

Response