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

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

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

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

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}

Request example

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

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.dify.ai/v1/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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/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 = url.scheme == 'https'

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response

{
  "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"
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_request",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "failure": {
    "action": "contact_admin",
    "category": "authorization",
    "code": "KNOWLEDGE_FS_ACCESS_DENIED",
    "message": "You do not have permission to perform this Agent Knowledge Base operation.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "You do not have permission to perform this Agent Knowledge Base operation.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "failure": {
    "action": "contact_admin",
    "category": "internal",
    "code": "KNOWLEDGE_FS_INTERNAL_ERROR",
    "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
  "status": 502
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

get/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

knowledge_base_idstringrequired#

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

document_idstringrequired#

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

task_idstringrequired#

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

Responses

application/json

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

active_operationsstring[]#

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

completed_atstring#

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

created_atstring#

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

document_idstring#

ドキュメント ID です。

document_revisioninteger#

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

error_codestring#

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

error_messagestring#

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

failureobject#

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

Show child attributes

actionstring#

推奨される次の対応です。ある場合は configure_model、configure_parser、configure_source、contact_admin、reupload、retry のいずれかです。該当しない場合は null で、HTTP エラーのボディでは省略されます。

categorystring#

失敗の種類で、authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout、validation のいずれかです。

codestring#

大文字のスネークケースで表される固定のエラーコードです（例：KNOWLEDGE_FS_CONFLICT、SOURCE_CREDENTIAL_TEST_FAILED）。

messagestring#

エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。

parametersobject#

失敗の内容を補足する最大 8 個の値です。キーは attempt、currentRowVersion、documentCount、expectedRowVersion、fileSizeBytes、limit、maxFileSizeBytes、maxItems、modelType、providerKind、retryAfterSeconds、status のいずれかです。値がない場合は null で、HTTP エラーのボディでは省略されます。

retryPolicystring#

再試行で解決できるかどうかです。automatic（サービスが自動で再試行）、manual（呼び出し側で再試行）、after_configuration（先に Dify でナレッジベースの設定を修正）、never（リクエストを変更）のいずれかです。

stagestring#

失敗が発生した段階です（例：query_generation、credential-test）。該当しない場合は null で、HTTP エラーのボディでは省略されます。

traceIdstring#

管理者に問い合わせる際に伝える参照情報です。失敗の詳細を含む成功レスポンスでは null になることがあり、HTTP エラーのボディでは省略されることがあります。

idstring#

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

knowledge_space_idstring#

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

phasestring#

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

progress_percentinteger#

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

retry_atstring#

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

semantic_enrichmentobject#

リビジョン公開後のナレッジグラフの構築です。インデックス処理が公開前にナレッジグラフの構築まで済ませるため、この処理は実行されません。タスクの実行中、state は not_scheduled で、終了後は disabled になります。nodes_completed は 0 のままです。

Show child attributes

error_codestring#

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

error_messagestring#

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

failureobject#

state が failed の場合のエラー詳細です。それ以外の場合は null です。

Show child attributes

actionstring#

categorystring#

失敗の種類で、authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout、validation のいずれかです。

codestring#

大文字のスネークケースで表される固定のエラーコードです（例：KNOWLEDGE_FS_CONFLICT、SOURCE_CREDENTIAL_TEST_FAILED）。

messagestring#

エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。

parametersobject#

retryPolicystring#

stagestring#

失敗が発生した段階です（例：query_generation、credential-test）。該当しない場合は null で、HTTP エラーのボディでは省略されます。

traceIdstring#

nodes_completedinteger#

構築済みのナレッジグラフのノード数です。state が ready になるまでは 0 で、その後は nodes_total と同じ値になります。

nodes_totalinteger#

構築するナレッジグラフのノード数です。判明するまでは null です。

provider_callsinteger#

これまでのモデル呼び出し回数です。

provider_calls_maximuminteger#

ナレッジグラフの構築で実行できるモデル呼び出しの最大回数です。

statestring#

not_scheduled、pending、running、ready、failed、disabled のいずれかです。

updated_atstring#

エンリッチメントが最後に変更された日時（ISO 8601）です。

stagestring#

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

statestring#

実行状態です：

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

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

updated_atstring#

タスクが最後に変更された日時（ISO 8601）です。

ドキュメントのインデックスタスク一覧を取得バックグラウンドタスク一覧を取得