> ## 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 Settings Migration > Returns the progress of the migration that [Update Knowledge Base Settings](/en/api-reference/settings/update-knowledge-base-settings) started when it answered `202`. Poll it until `run_state` is `succeeded`, `failed`, or `canceled`. Once it has `succeeded`, read the new settings and their `revision` with [Get Knowledge Base Settings](/en/api-reference/settings/get-knowledge-base-settings). For the update-and-poll flow, see [Change Models or Retrieval Settings](/en/api-reference/guides/knowledge-base#change-models-or-retrieval-settings). ## OpenAPI ````yaml /en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_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}/settings/migrations/{migration_id}: get: tags: - Settings summary: Get Settings Migration description: >- Returns the progress of the migration that [Update Knowledge Base Settings](/en/api-reference/settings/update-knowledge-base-settings) started when it answered `202`. Poll it until `run_state` is `succeeded`, `failed`, or `canceled`. Once it has `succeeded`, read the new settings and their `revision` with [Get Knowledge Base Settings](/en/api-reference/settings/get-knowledge-base-settings). For the update-and-poll flow, see [Change Models or Retrieval Settings](/en/api-reference/guides/knowledge-base#change-models-or-retrieval-settings). operationId: getSettingsMigration 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: >- Migration ID: `migration.id` from the `202` response of [Update Knowledge Base Settings](/en/api-reference/settings/update-knowledge-base-settings). No other operation returns it. in: path name: migration_id required: true schema: format: uuid type: string responses: '200': content: application/json: examples: running: summary: Response Example - Running value: candidate_publication_fingerprint: >- projection-set-sha256:9ce0b7c3b431e0f6550f3f16020732e205ce28e1a5f86426e0cf79e7499563b8 changed_kind: embedding checkpoint: candidate-built completed_at: null created_at: '2026-10-20T03:10:00Z' error_code: null evaluation_summary: null id: a7c3e9f1-2b4d-4c6e-8f0a-1b3d5f7a9c2e knowledge_space_id: 0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d rebuild_scope: full-vector-space run_state: running updated_at: '2026-10-20T03:14:12Z' succeeded: summary: Response Example - Succeeded value: candidate_publication_fingerprint: >- projection-set-sha256:9ce0b7c3b431e0f6550f3f16020732e205ce28e1a5f86426e0cf79e7499563b8 changed_kind: embedding checkpoint: activated completed_at: '2026-10-20T03:18:40Z' created_at: '2026-10-20T03:10:00Z' error_code: null evaluation_summary: denseProjections: 12 documents: 12 ftsProjections: 12 pageIndexBuilds: 12 rebuildScope: full-vector-space vectorSpaceId: >- embedding-space-sha256:834f47168e39e45d54066b9437e538ba7f12dadfcaea6a93924ce93e99c97a82 id: a7c3e9f1-2b4d-4c6e-8f0a-1b3d5f7a9c2e knowledge_space_id: 0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d rebuild_scope: full-vector-space run_state: succeeded updated_at: '2026-10-20T03:18:40Z' schema: $ref: '#/components/schemas/KnowledgeBaseSettingsMigration' description: The migration. '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 knowledge_fs_invalid_request_upstream: summary: knowledge_fs_invalid_request (rejected) value: 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 description: |- - `knowledge_fs_invalid_request`: `migration_id` is not a UUID. - `knowledge_fs_invalid_request`: `migration_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_scope: summary: knowledge_fs_access_denied (key scope) value: code: knowledge_fs_access_denied message: Agent Knowledge Base operation is not allowed. 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. - `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: 7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83 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 migration with this ID belongs to this knowledge base. - `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 (service error) value: 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 knowledge_fs_upstream_unavailable_transport: summary: knowledge_fs_upstream_unavailable (no response) 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: KnowledgeBaseSettingsMigration: properties: candidate_publication_fingerprint: description: Internal. Not needed to follow the migration. nullable: true type: string changed_kind: description: 'What the change touched: `embedding` or `retrieval`.' type: string checkpoint: description: >- Last step reached: `queued`, `candidate-built`, `evaluated`, or `activated`. type: string completed_at: description: >- When the migration ended (`succeeded`, `failed`, or `canceled`), ISO 8601. `null` while it runs. nullable: true type: string created_at: description: When the migration started, ISO 8601. type: string error_code: description: >- Code of the last failure, for example `PROFILE_MIGRATION_ATTEMPTS_EXHAUSTED` or `VECTOR_SPACE_QUOTA_EXCEEDED`. `null` when none. nullable: true type: string evaluation_summary: description: >- Flat map of evaluation results recorded for the rebuilt index. `null` when none was recorded. nullable: true type: object id: description: >- Migration ID. Pass it to [Get Settings Migration](/en/api-reference/settings/get-settings-migration). type: string knowledge_space_id: description: >- Internal ID of the knowledge base. Not the knowledge base ID in the path. type: string rebuild_scope: description: >- What the migration rebuilds: - `full-vector-space`: an embedding model change re-embeds every document. - `full-page-index-summary-outline`: a reasoning model change rebuilds the page index, summaries, and outlines. - `clone-publication`: any other retrieval change reuses the current index. type: string run_state: description: >- Progress of the migration: - `queued`, `running`: in progress. - `succeeded`: the new settings are in effect. - `failed`: stopped. `error_code` says why. Check the models in [Get Knowledge Base Settings](/en/api-reference/settings/get-knowledge-base-settings) before trying the change again. - `canceled`: a newer change of the same kind replaced this migration before it finished. Follow the newer one. type: string updated_at: description: When the migration last changed, ISO 8601. 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.