Skip to main content
GET
/
datasets
/
{dataset_id}
/
documents
/
{document_id}
ドキュメント詳細を取得
curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id}/documents/{document_id} \
  --header 'Authorization: Bearer <token>'
import requests

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

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/{dataset_id}/documents/{document_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}/documents/{document_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}/documents/{document_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))

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

url = URI("https://{api_base_url}/datasets/{dataset_id}/documents/{document_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
{
  "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
  "position": 1,
  "data_source_type": "upload_file",
  "data_source_info": {
    "upload_file": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "guide.txt",
      "size": 2048,
      "extension": "txt",
      "mime_type": "text/plain",
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "created_at": 1741267200
    }
  },
  "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
  "dataset_process_rule": {
    "id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "mode": "custom"
  },
  "document_process_rule": {
    "mode": "custom",
    "rules": {
      "pre_processing_rules": [],
      "segmentation": {
        "separator": "###",
        "max_tokens": 500,
        "chunk_overlap": 50
      }
    }
  },
  "name": "guide.txt",
  "created_from": "api",
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "created_at": 1741267200,
  "tokens": 512,
  "indexing_status": "completed",
  "error": null,
  "enabled": true,
  "disabled_at": null,
  "disabled_by": null,
  "archived": false,
  "display_status": "available",
  "hit_count": 0,
  "doc_form": "text_model",
  "doc_language": "English",
  "doc_type": null,
  "doc_metadata": [],
  "completed_at": 1741267260,
  "updated_at": 1741267260,
  "indexing_latency": 60,
  "segment_count": 5,
  "average_segment_length": 70,
  "summary_index_status": null,
  "need_summary": false
}

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 が返されます。

Path Parameters

dataset_id
string<uuid>
required

ナレッジベース ID です。

document_id
string<uuid>
required

Document ID.

Query Parameters

metadata
enum<string>
default:all

all はメタデータを含むすべてのフィールドを返します。onlyiddoc_typedoc_metadata のみを返します。withoutdoc_metadata を除くすべてのフィールドを返します。

Available options:
all,
only,
without

Response

ドキュメントの詳細です。レスポンスの形式は metadata クエリパラメータによって異なります。metadataonly の場合、iddoc_typedoc_metadata のみが返されます。metadatawithout の場合、doc_typedoc_metadata は省略されます。

id
string

ドキュメント識別子です。

position
integer

ナレッジベース内の位置インデックスです。

data_source_type
string

ドキュメントのアップロード方法です。ファイルアップロードの場合は upload_file、Notion インポートの場合は notion_import です。

data_source_info
object

データソースの詳細です。ファイルアップロードの場合、この詳細エンドポイントは upload_file 配下に完全なファイルオブジェクトを返します(リストエンドポイントは upload_file_id のみを返します)。

dataset_process_rule_id
string

このドキュメントに適用された処理ルールの ID です。

dataset_process_rule
object

ナレッジベースレベルの処理ルール設定です。

document_process_rule
object

ドキュメントレベルの処理ルール設定です。

name
string

ドキュメント名です。

created_from
string

ドキュメントの作成元です。API で作成した場合は api、UI で作成した場合は web です。

created_by
string

ドキュメントを作成したユーザーの ID です。

created_at
number

ドキュメント作成の Unix タイムスタンプです。

tokens
integer

ドキュメント内のトークン数です。

indexing_status
string

現在のインデックスステータスです(例:waitingparsingcleaningsplittingindexingcompletederrorpaused)。

error
string | null

インデックス作成が失敗した場合のエラーメッセージです。それ以外は null です。

enabled
boolean

このドキュメントが検索に対して有効かどうかです。

disabled_at
number | null

ドキュメントが無効化された Unix タイムスタンプです。有効な場合は null です。

disabled_by
string | null

ドキュメントを無効化したユーザーの ID です。有効な場合は null です。

archived
boolean

ドキュメントがアーカイブ済みかどうかです。

display_status
string

UI 向けの表示用インデックスステータスです。

hit_count
integer

このドキュメントが検索された回数です。

doc_form
string

ドキュメントのチャンキングモードです。text_model は標準テキスト、hierarchical_model は親子構造、qa_model は QA ペアを示します。

doc_language
string

ドキュメント内容の言語です。

doc_type
string | null

ドキュメントタイプの分類です。未設定の場合は null です。

doc_metadata
object[]

このドキュメントのカスタムメタデータキーバリューペア。

completed_at
number | null

処理が完了した Unix タイムスタンプです。まだ完了していない場合は null です。

updated_at
number | null

最終更新の Unix タイムスタンプです。更新されたことがない場合は null です。

indexing_latency
number | null

インデックス作成にかかった時間(秒)です。未完了の場合は null です。

segment_count
integer

ドキュメント内のチャンク数です。

average_segment_length
number

チャンクの平均文字長です。

summary_index_status
string | null

要約インデックスのステータスです。要約インデックスが有効でない場合は null です。

need_summary
boolean

このドキュメントが要約生成を必要とするかどうかです。

Last modified on July 9, 2026