Skip to main content
GET
/
datasets
ナレッジベースリストを取得
curl --request GET \
  --url https://{api_base_url}/datasets \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets', 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",
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"

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))

}
HttpResponse<String> response = Unirest.get("https://{api_base_url}/datasets")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "data": [
    {
      "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9",
      "name": "Product Documentation",
      "description": "プロダクト API 技術ドキュメント",
      "provider": "vendor",
      "permission": "only_me",
      "data_source_type": null,
      "indexing_technique": "high_quality",
      "app_count": 0,
      "document_count": 0,
      "word_count": 0,
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "author_name": "admin",
      "created_at": 1741267200,
      "updated_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "updated_at": 1741267200,
      "embedding_model": "text-embedding-3-small",
      "embedding_model_provider": "openai",
      "embedding_available": true,
      "retrieval_model_dict": {
        "search_method": "semantic_search",
        "reranking_enable": false,
        "reranking_mode": null,
        "reranking_model": {
          "reranking_provider_name": "",
          "reranking_model_name": ""
        },
        "weights": null,
        "top_k": 3,
        "score_threshold_enabled": false,
        "score_threshold": null
      },
      "tags": [],
      "doc_form": "text_model",
      "external_knowledge_info": null,
      "external_retrieval_model": null,
      "doc_metadata": [],
      "built_in_field_enabled": true,
      "pipeline_id": null,
      "runtime_mode": null,
      "chunk_structure": null,
      "icon_info": null,
      "summary_index_setting": null,
      "is_published": false,
      "total_documents": 0,
      "total_available_documents": 0,
      "enable_api": true,
      "is_multimodal": false,
      "maintainer": "admin"
    }
  ],
  "has_more": false,
  "limit": 20,
  "total": 1,
  "page": 1
}

Authorizations

Authorization
string
header
required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例:Authorization: Bearer {API_KEY}API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。API Key が欠落または無効な場合、HTTP 401 とエラーコード unauthorized が返されます。

Query Parameters

page
integer
default:1

取得するページ番号。

limit
integer
default:20

1 ページあたりの件数です。

keyword
string

名前でフィルタリングする検索キーワードです。

include_all
boolean
default:false

権限に関係なくすべてのナレッジベースを含めるかどうかです。

tag_ids
string[]

フィルタリングに使用するタグ ID です。

Response

200 - application/json

ナレッジベースのリストです。

data
object[]

ナレッジベースオブジェクトの配列です。

has_more
boolean

次のページにさらに項目が存在するかどうかです。

limit
integer

1 ページあたりの件数です。

total
integer

一致する項目の合計数です。

page
integer

現在のページ番号です。

Last modified on July 9, 2026