ドキュメントのメタデータを取得する

ドキュメント ID を指定してメタデータ値を一括取得し、auto_metadata（システムによる自動入力、読み取り専用）と metadata（カスタムフィールド値）を返します。1 回のリクエストで最大 50 件のドキュメントを取得できます。

リクエストメソッド

GET

エンドポイント

https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/detail

認証

認証方法については、API 概要を参照してください。

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/detail?doc_ids=doc_001,doc_002' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/detail?doc_ids=doc_001,doc_002' \
-H 'Authorization: Bearer ${API Key}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	型	説明
Authorization	Bearer ${API Key}	`Authorization: Bearer ${API Key}` で認証します。API キーページで API Key を取得してください。

リクエストパラメータ

フィールド	型	必須	説明
doc_ids	String	はい	カンマ区切りのドキュメント ID。一度に最大 50 件。すべてのドキュメントが現在の API Key に関連付けられた Agent に属している必要があります。存在しない、または現在の Agent に属していないドキュメントが 1 件でもある場合、リクエスト全体が `one or more doc_ids do not exist or do not belong to the current bot` で失敗します。

レスポンス

レスポンス例

{ "documents": [ { "doc_id": "doc_001", "auto_metadata": { "document_name": "API仕様.pdf", "upload_time": "2026-01-15T10:30:00Z" }, "metadata": { "category": "技術", "priority": "P1" } } ] }

                      
                      {
    "documents": [
        {
            "doc_id": "doc_001",
            "auto_metadata": {
                "document_name": "API仕様.pdf",
                "upload_time": "2026-01-15T10:30:00Z"
            },
            "metadata": {
                "category": "技術",
                "priority": "P1"
            }
        }
    ]
}

このコードブロックをポップアップで表示

成功レスポンス

フィールド	型	説明
documents	Array<Object>	各ドキュメントのメタデータ。メタデータレコードのないドキュメントは返されません。
doc_id	String	ドキュメント ID。
auto_metadata	Object	システムによって自動的に入力されるメタデータ (ドキュメント名/アップロード時間/アップローダー/ソースなど)、読み取り専用。
metadata	Object	カスタムメタデータ値。形式は「フィールド名 → 値」です。

エラーレスポンス

フィールド	型	説明
code	Integer	エラーコード。
message	String	エラーの詳細。