Skip to main content
POST

Authorizations

​
Authorization
string
header
required

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Headers

​
Idempotency-Key
string

毎回の呼び出しでキーを送信してください。キーがあれば、呼び出しを安全に再試行できます。前後に空白を含まない、8〜255 文字の印字可能な ASCII 文字を使用してください。キーの形式が正しくない場合は 400 が返ります。

同じキーと同じボディを再送信すると、新しいインデックスタスクは開始されず、元の一括タスクが返されます。異なるボディ、別の API キー、別のナレッジベース、または別の操作で同じキーを再利用すると 409 が返ります。

Required string length: 8 - 255

Path Parameters

​
knowledge_base_id
string<uuid>
required

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。

Body

application/json

nullable と記されたオプションフィールドでは、null は省略と同じ扱いになります。

正規化後のリクエストは、UTF-8 で 1,048,576 バイト以内に収める必要があります。リクエストサイズの制限 を参照してください。

all: true または空でない documentIds 配列のどちらかを送信します。両方は送信できません。documentIds を送る場合、all は省略するか、false または null にできます。all: true を送る場合、documentIds は省略するか null にできます。空の配列は拒否されます。

​
all
enum<boolean>
required

true にすると、API キーで読み取れるすべてのドキュメントファイルを再インデックスします。対象が上限（デフォルトは 100）を超える場合は 400 が返り、何も再インデックスされません。

Available options:
true
​
documentIds
string<uuid>[] | null

再インデックスするドキュメントです。ドキュメント ID（ドキュメント一覧を取得 から取得）またはドキュメントファイル ID（ドキュメントファイル一覧を取得 から取得）で指定します。デプロイ環境によっては、より低い上限が設定されている場合があります。重複した ID は 1 つにまとめられるため、total が送信した数より小さくなることがあります。各 ID を 1 回ずつ送信すれば、items はリクエストと同じ順序で並びます。

Required array length: 1 - 100 elements

Response

インデックスタスクがキューに追加されました。

​
bulk_job_id
string

一括タスク ID です。一括タスクを取得 でポーリングします。

​
items
object[]

送信した重複のない ID ごとに 1 エントリが、リクエストの順序で並びます。all が true の場合は、その後に選択された各ファイルにつき 1 エントリが続きます。同じドキュメントファイルに解決される ID は、1 つのエントリを共有します。

​
total
integer

items のエントリ数です。