> ## Documentation Index > Fetch the complete documentation index at: https://docs.dify.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Bulk Task > Returns the progress of the indexing tasks in a bulk task. In this API a bulk task comes from [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents), and only the API key that started it can read it. Items that [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents) reported as `not_found` count as completed, so `completed_items` can equal `total_items` even when no document was re-indexed. Compare `total_items` with the number of `queued` items in that response to catch it. For the re-index flow, see [Re-index and Track Indexing](/en/api-reference/guides/knowledge-base#track-indexing). ## OpenAPI ````yaml /en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id} openapi: 3.0.1 info: description: >- REST API for Dify applications and knowledge bases. Application endpoints authenticate with an app API key; knowledge endpoints authenticate with a dataset API key. title: Dify Service API version: 1.0.0 servers: - description: >- Base URL of the Dify Service API. For self-hosted deployments, replace it with your own API base URL. url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: Host and path of the API base URL, without the `https://` prefix. security: - ApiKeyAuth: [] tags: - description: Operations related to chat messages and interactions. name: Chat Messages - description: File upload and preview operations. name: Files - description: Operations related to end user information. name: End Users - description: User feedback operations. name: Feedback - description: Operations related to managing conversations. name: Conversations - description: Text-to-Speech and Speech-to-Text operations. name: Audio - description: Operations to retrieve application settings and information. name: Applications - description: Operations related to managing annotations for direct replies. name: Annotations - description: Endpoints for resuming paused workflows that require human input. name: Human Input - description: Operations for executing and managing workflows. name: Workflow Runs - description: Operations related to text generation and completion. name: Completion Messages - description: >- Operations for managing knowledge bases, including creation, configuration, and retrieval. name: Knowledge Bases - description: >- Operations for creating, updating, and managing documents within a knowledge base. name: Documents - description: Operations for managing document chunks and child chunks. name: Chunks - description: >- Operations for managing knowledge base metadata fields and document metadata values. name: Metadata - description: Operations for managing knowledge base tags and tag bindings. name: Tags - description: Operations for retrieving available models. name: Models - description: >- Operations for managing and running knowledge pipelines, including datasource plugins and pipeline execution. name: Knowledge Pipeline - description: Ask a knowledge base a question and stream the answer. name: Queries - description: Inspect what a query retrieved and why. name: Query Records - description: Run a research question in the background and collect its results. name: Research Tasks - description: >- Read the documents in a knowledge base, their files, revisions, and chunks; label documents with metadata. name: Documents and Chunks - description: >- Follow, cancel, or retry indexing, and list the knowledge base's background tasks. name: Indexing Tasks - description: >- Follow the deletion of a document file, a batch of files, or a source until it finishes. name: Deletion Jobs - description: >- Manage the sources that feed a knowledge base, their sync schedules, and their connections. name: Sources - description: >- Sync a source now, import website pages or provider items, and follow, cancel, or retry the runs. name: Source Syncs and Imports - description: >- Read and change the knowledge base's models and retrieval settings, and follow the migration a change starts. name: Settings paths: /knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id}: get: tags: - Indexing Tasks summary: Get Bulk Task description: >- Returns the progress of the indexing tasks in a bulk task. In this API a bulk task comes from [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents), and only the API key that started it can read it. Items that [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents) reported as `not_found` count as completed, so `completed_items` can equal `total_items` even when no document was re-indexed. Compare `total_items` with the number of `queued` items in that response to catch it. For the re-index flow, see [Re-index and Track Indexing](/en/api-reference/guides/knowledge-base#track-indexing). operationId: getBulkTask parameters: - description: >- Knowledge base ID: the last segment of the Service API endpoint shown in the knowledge base's **API Access** dialog (`…/knowledge-fs/spaces/`), and the segment after `/datasets/new/` in the address bar. in: path name: knowledge_base_id required: true schema: format: uuid type: string - description: >- Bulk task ID: `bulk_job_id` of the [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents) response. [List Background Tasks](/en/api-reference/indexing-tasks/list-background-tasks) also returns it, as the `id` of a `document_bulk` task. in: path name: bulk_task_id required: true schema: format: uuid type: string responses: '200': content: application/json: examples: success: summary: Response Example value: canceled_items: 0 completed_items: 1 created_at: '2026-09-06T02:30:00Z' failed_item_ids: [] failed_items: 0 failures: [] id: c7d9e1f3-5a7b-4c9d-8e0f-1a2b3c4d5e6f knowledge_space_id: 9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b status: running total_items: 2 type: document_reindex updated_at: '2026-09-06T02:31:12Z' schema: properties: canceled_items: description: >- Items whose task was canceled, including documents that were disabled when the re-index was requested. type: integer completed_items: description: Items that completed or were reported as `not_found`. type: integer created_at: description: When the bulk task was created, ISO 8601. type: string failed_item_ids: description: >- IDs of the failed items, as submitted to [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents). They are not indexing task IDs. Map them to tasks with the `items` entries you kept from that response. items: type: string type: array failed_items: description: Items whose task failed. type: integer failures: description: One entry per failed item. Empty when none failed. items: properties: document_id: description: >- The item's ID, as submitted to [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents). type: string document_title: description: Title of the document. `null` when unknown. nullable: true type: string error_code: description: Failure code. type: string error_message: description: Failure message. type: string failure: allOf: - $ref: '#/components/schemas/KnowledgeBaseErrorDetails' description: Error details. `null` when none were recorded. nullable: true job_id: description: ID of the item's job. `null` when none was recorded. nullable: true type: string type: object type: array id: description: Bulk task ID. type: string knowledge_space_id: description: >- Internal ID of the knowledge base. Not the knowledge base ID in the path. type: string status: description: >- Aggregate state: - `running`: at least one item is still in progress. - `completed`: every item completed (reached at least `projection_built`, which comes before `published`) or was reported as `not_found`. - `failed`: every item is terminal and at least one failed. - `canceled`: every item is terminal, none failed, and at least one was canceled. `completed` does not guarantee that the new revisions are active yet. When that matters, check each task with [Get Indexing Task](/en/api-reference/indexing-tasks/get-indexing-task) for `stage: published`, using the task IDs you kept from [Re-index Documents](/en/api-reference/documents-and-chunks/re-index-documents). type: string total_items: description: Number of items submitted. type: integer type: description: >- `document_reindex` for bulk tasks from this API. `document_upload` and `document_delete` arise only from Dify operations. A deletion over this API answers with a deletion job, which is not a bulk task: follow it with [Get Deletion Job](/en/api-reference/deletion-jobs/get-deletion-job) or [Get Deletion Batch](/en/api-reference/deletion-jobs/get-deletion-batch). type: string updated_at: description: >- Latest change across the bulk task and its indexing tasks, ISO 8601. type: string type: object description: The bulk task. '400': content: application/json: examples: knowledge_fs_invalid_request_path: summary: knowledge_fs_invalid_request (path ID) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 description: '- `knowledge_fs_invalid_request`: `bulk_task_id` is malformed.' '401': content: application/json: examples: knowledge_fs_invalid_credential: summary: knowledge_fs_invalid_credential value: code: knowledge_fs_invalid_credential message: Invalid Agent Knowledge Base service credential. status: 401 unauthorized: summary: unauthorized value: code: unauthorized message: Access token is invalid status: 401 description: >- - `unauthorized`: the `Authorization` header is missing, or the key is unknown or not a knowledge base API key. - `knowledge_fs_invalid_credential`: the key is valid, but no knowledge base with this ID exists in the key's workspace, or the key is not tied to a workspace. '403': content: application/json: examples: forbidden: summary: forbidden (rate limit) value: code: forbidden message: >- Sorry, you have reached the knowledge base request rate limit of your subscription. status: 403 knowledge_fs_access_denied: summary: knowledge_fs_access_denied (key scope) value: code: knowledge_fs_access_denied message: Agent Knowledge Base operation is not allowed. status: 403 knowledge_fs_access_denied_2: summary: knowledge_fs_access_denied (upstream) value: 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: 8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2 message: >- You do not have permission to perform this Agent Knowledge Base operation. status: 403 description: >- - `knowledge_fs_access_denied`: the key is scoped to other knowledge bases, **API access** is off for this knowledge base, or the knowledge base is not active. - `knowledge_fs_access_denied`: the key has no access to this knowledge base's content. - `forbidden`: on Dify Cloud, the workspace has reached the knowledge base request rate limit of its subscription. Every call counts, reads included. '404': content: application/json: examples: knowledge_fs_resource_not_found: summary: knowledge_fs_resource_not_found value: 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: 8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2 message: The requested Agent Knowledge Base resource was not found. status: 404 not_found: summary: not_found (feature off) value: 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 description: >- - `knowledge_fs_resource_not_found`: no bulk task has this ID, another API key started it, or one of its document files is not readable with this key. - `not_found`: the Agent Knowledge Base feature is turned off on this deployment. '502': content: application/json: examples: knowledge_fs_upstream_unavailable: summary: knowledge_fs_upstream_unavailable value: code: knowledge_fs_upstream_unavailable message: Agent Knowledge Base is unavailable. status: 502 description: >- - `knowledge_fs_upstream_unavailable`: no answer came back in time, or the answer couldn't be read. Retry after a pause. '503': content: application/json: examples: knowledge_fs_operation_unavailable: summary: knowledge_fs_operation_unavailable value: code: knowledge_fs_operation_unavailable message: Agent Knowledge Base operation is not available. status: 503 knowledge_fs_operation_unavailable_upstream: summary: knowledge_fs_operation_unavailable (temporary) value: 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 description: >- - `knowledge_fs_operation_unavailable`: the Agent Knowledge Base feature is not set up for this workspace, this operation is not available on the deployment, or the key's access to this knowledge base changed while the request was being authorized. - `knowledge_fs_operation_unavailable`: the request can't be served right now. Follow `failure.retryPolicy`. components: schemas: KnowledgeBaseErrorDetails: properties: action: description: >- Suggested next step, when there is one: `configure_model`, `configure_parser`, `configure_source`, `contact_admin`, `reupload`, or `retry`. `null` when not applicable; omitted from HTTP error bodies. nullable: true type: string category: description: >- Kind of failure: `authorization`, `canceled`, `configuration`, `conflict`, `dependency`, `internal`, `not_found`, `rate_limit`, `timeout`, or `validation`. type: string code: description: >- Stable error code in upper snake case, for example `KNOWLEDGE_FS_CONFLICT` or `SOURCE_CREDENTIAL_TEST_FAILED`. type: string message: description: >- Public message for the error code or failure category. Provider error details are not exposed. type: string parameters: additionalProperties: true description: >- Up to 8 values that qualify the failure, with keys among `attempt`, `currentRowVersion`, `documentCount`, `expectedRowVersion`, `fileSizeBytes`, `limit`, `maxFileSizeBytes`, `maxItems`, `modelType`, `providerKind`, `retryAfterSeconds`, and `status`. `null` when there are none; omitted from HTTP error bodies. nullable: true type: object retryPolicy: description: >- Whether a retry can help: `automatic` (the service retries on its own), `manual` (retry yourself), `after_configuration` (fix the knowledge base's setup in Dify first), or `never` (change the request). type: string stage: description: >- Stage the failure belongs to, for example `query_generation` or `credential-test`. `null` when not applicable; omitted from HTTP error bodies. nullable: true type: string traceId: description: >- Reference to quote when contacting an administrator. May be `null` in a successful response containing failure details, or omitted from an HTTP error body. nullable: true type: string type: object securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- Every request authenticates with an API key: `Authorization: Bearer {API_KEY}`. App endpoints take an app API key; knowledge endpoints take a knowledge base API key ([Get Started](/en/api-reference/guides/get-started)). Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP `401` (`unauthorized`). scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.