ファイルからドキュメントを作成

アップロードしたファイルからナレッジベースにドキュメントを作成します。PDF、TXT、DOCX などの一般的な形式をサポートします。インデックスは非同期で実行されます。返された batch ID を使って ドキュメント埋め込みステータス（進捗）を取得 で追跡します。

POST /datasets/{dataset_id}/document/create-by-file

ファイルからドキュメントを作成

cURL

curl --request POST \
  --url https://{api_base_url}/datasets/{dataset_id}/document/create-by-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@example-file \
  --form 'data={"indexing_technique":"high_quality","doc_language":"English","process_rule":{"mode":"automatic"}}'

200

success

{
  "batch": "20250306150245647595",
  "document": {
    "archived": false,
    "created_at": 1741267200,
    "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
    "created_from": "api",
    "data_source_detail_dict": {
      "upload_file": {
        "created_at": 1741267200,
        "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
        "extension": "txt",
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "mime_type": "text/plain",
        "name": "guide.txt",
        "size": 2048
      }
    },
    "data_source_info": {
      "upload_file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "data_source_type": "upload_file",
    "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "disabled_at": null,
    "disabled_by": null,
    "display_status": "indexing",
    "doc_form": "text_model",
    "doc_metadata": [],
    "enabled": true,
    "error": null,
    "hit_count": 0,
    "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
    "indexing_status": "indexing",
    "name": "guide.txt",
    "need_summary": false,
    "position": 1,
    "summary_index_status": null,
    "tokens": 0,
    "word_count": 0
  }
}

Authorizations

Authorization · string · header · required

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

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401（unauthorized）が返ります。

Path Parameters

dataset_id · string<uuid> · required

ナレッジベース ID。ナレッジベースリストを取得 で取得します。スコープを限定したキーでは、Dify の URL から ID をコピー してください。

Body

multipart/form-data

file · file · required

アップロードするファイルです。デフォルトの上限は 15 MB です。

セルフホスト環境では UPLOAD_FILE_SIZE_LIMIT 環境変数 で調整できます。Dify Cloud の Professional と Team プランでは上限が 50 MB になります。

data · string

設定情報を含む JSON 文字列です。テキストからドキュメントを作成 と同じフィールド（indexing_technique、doc_form、doc_language、process_rule、retrieval_model、embedding_model、embedding_model_provider）を受け付けますが、name と text は除きます。

Example:

"{\"indexing_technique\":\"high_quality\",\"doc_language\":\"English\",\"process_rule\":{\"mode\":\"automatic\"}}"

Response

200

application/json

ドキュメントが正常に作成されました。

batch · string

インデックス進捗を追跡するためのバッチ ID です。

document · object

Show child attributes