インデックスタスク

ドキュメントのインデックスタスクを取得

ドキュメントのインデックスタスクを 1 件、進捗とナレッジグラフの状態とともに返します。state が succeeded、failed、canceled、superseded のいずれかになるまでポーリングしてください。

ドキュメントを再インデックスで開始したタスクの場合は、代わりに compilation_job.id を使ってインデックスタスクを取得をポーリングしてください。

どの場面でどのタスク操作を使うかについては、インデックス処理の追跡を参照してください。

GET

knowledge-fs

spaces

{knowledge_base_id}

logical-documents

{document_id}

processing-tasks

{task_id}

ドキュメントのインデックスタスクを取得

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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

{
  "active_operations": [
    "chunk",
    "fts_index",
    "embedding"
  ],
  "completed_at": null,
  "created_at": "2026-10-20T08:15:42Z",
  "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
  "document_revision": 2,
  "error_code": null,
  "error_message": null,
  "failure": null,
  "id": "c4e8a2f6-1b3d-4e5f-8a9b-0c1d2e3f4a5b",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "phase": "chunking_indexing",
  "progress_percent": 35,
  "retry_at": null,
  "semantic_enrichment": {
    "error_code": null,
    "error_message": null,
    "failure": null,
    "nodes_completed": 0,
    "nodes_total": null,
    "provider_calls": null,
    "provider_calls_maximum": null,
    "state": "not_scheduled",
    "updated_at": null
  },
  "stage": "outline_built",
  "state": "running",
  "updated_at": "2026-10-20T08:15:58Z"
}

Authorizations

Authorization

string

header

required

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

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

Path Parameters

knowledge_base_id

string<uuid>

required

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

document_id

string<uuid>

required

ドキュメント ID です。ドキュメント一覧を取得から取得します。

task_id

string<uuid>

required

インデックスタスク ID です。ドキュメントを取得またはドキュメント一覧を取得の latest_task.id、あるいはドキュメントのインデックスタスク一覧を取得の id を指定します。タスクはこのドキュメントに属している必要があります。

Response

インデックスタスクです。

active_operations

string[] | null

現在のフェーズで進行中の処理です（parse、chunk、embedding、publication など）。

completed_at

string | null

タスクの終了日時（ISO 8601）です。実行中は null です。

created_at

string

タスクの作成日時（ISO 8601）です。インデックスタスクを取得では、同じタスクの日時がエポックミリ秒で返されます。

document_id

string

ドキュメント ID です。

document_revision

integer

このタスクが構築するリビジョンです。

error_code

string | null

state が failed の場合のエラーコードです。

error_message

string | null

error_code に対応するメッセージです。failure.message と異なる場合があります。

failure

object | null

state が failed の場合のエラー詳細です。stage はタスクが失敗した phase、traceId はタスク ID です。それ以外の場合は null です。

Show child attributes

string

インデックスタスク ID です。同じ ID をインデックスタスクを取得、インデックスタスクをキャンセル、インデックスタスクを再試行でも使用できます。

knowledge_space_id

string

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

phase

string | null

タスクが現在行っている処理で、queued、parsing、outline_summary、chunking_indexing、graph_admission、publication、complete のいずれかです。

progress_percent

integer

stage から算出される、0 から 100 までの進捗です。

retry_at

string | null

自動再試行の実行日時（ISO 8601）です。state が retry_wait の間に設定されます。

semantic_enrichment

object | null

インデックスされたコンテンツに対するナレッジグラフの構築ステータスです。詳細検索とリサーチ検索は、ナレッジグラフをたどります。構築が予定されていなかった場合、state はタスクの実行中は not_scheduled、終了後は disabled になります。

Show child attributes

stage

string

到達した最後のチェックポイントです。queued、parsed、outline_built、nodes_generated、projection_built、smoke_eval_passed、published の順に進みます。タスクが失敗またはキャンセルされても最後のチェックポイントのままなので、結果は state で確認してください。

state

string

実行状態です：

dispatch_pending、queued：ワーカーを待っています。
retry_wait：retry_at に自動再試行が予定されています。
running：ワーカーがインデックス処理を実行しています。
succeeded：リビジョンが公開され、クエリに使われています。semantic_enrichment はまだ実行中の場合があります。
failed：failure を参照してください。インデックスタスクを再試行で再開できます。
canceled
superseded：新しい試行に置き換えられました。

succeeded、failed、canceled、superseded は最終状態です。

updated_at

string

タスクまたはそのエンリッチメントが最後に変更された日時（ISO 8601）です。

ドキュメントのインデックスタスクを取得

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_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

{
  "active_operations": [
    "chunk",
    "fts_index",
    "embedding"
  ],
  "completed_at": null,
  "created_at": "2026-10-20T08:15:42Z",
  "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
  "document_revision": 2,
  "error_code": null,
  "error_message": null,
  "failure": null,
  "id": "c4e8a2f6-1b3d-4e5f-8a9b-0c1d2e3f4a5b",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "phase": "chunking_indexing",
  "progress_percent": 35,
  "retry_at": null,
  "semantic_enrichment": {
    "error_code": null,
    "error_message": null,
    "failure": null,
    "nodes_completed": 0,
    "nodes_total": null,
    "provider_calls": null,
    "provider_calls_maximum": null,
    "state": "not_scheduled",
    "updated_at": null
  },
  "stage": "outline_built",
  "state": "running",
  "updated_at": "2026-10-20T08:15:58Z"
}

ガイド

アプリ API

ナレッジ API

ドキュメントのインデックスタスクを取得

Authorizations

Path Parameters

Response