Get Settings Migration

get/knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_id}

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_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}/settings/migrations/{migration_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

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

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

{
  "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_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}/settings/migrations/{migration_id}

Authorization

Authorizationstringheaderrequired#

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).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path parameters

knowledge_base_idstringrequired#

Knowledge base ID: the last segment of the Service API endpoint shown in the knowledge base's API Access dialog (…/knowledge-fs/spaces/<knowledge base ID>), and the segment after /datasets/new/ in the address bar.

migration_idstringrequired#

Migration ID: migration.id from the 202 response of Update Knowledge Base Settings. No other operation returns it.

Responses

application/json

The migration.

candidate_publication_fingerprintstring#

Internal. Not needed to follow the migration.

changed_kindstring#

What the change touched: embedding or retrieval.

checkpointstring#

Last step reached: queued, candidate-built, evaluated, or activated. To tell when the migration ends, read run_state.

completed_atstring#

When the migration ended (succeeded, failed, or canceled), ISO 8601. null while it runs.

created_atstring#

When the migration started, ISO 8601.

error_codestring#

Code of the last failure, for example PROFILE_MIGRATION_ATTEMPTS_EXHAUSTED or VECTOR_SPACE_QUOTA_EXCEEDED. null when none.

evaluation_summaryobject#

Flat map of results recorded for the migration. Not needed to follow the migration. null when none was recorded.

idstring#

Migration ID. Pass it to Get Settings Migration.

knowledge_space_idstring#

Internal ID of the knowledge base. Not the knowledge base ID in the path.

rebuild_scopestring#

What the migration rebuilds:

full-vector-space: an embedding model change re-embeds every document.
clone-publication: any retrieval change reuses the current index.
full-page-index-summary-outline: deprecated. Older migrations may still report it; a reasoning model change reports clone-publication.

run_statestring#

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 before trying the change again.
canceled: a newer change of the same kind replaced this migration before it finished. Follow the newer one.

updated_atstring#

When the migration last changed, ISO 8601.

Update Knowledge Base Settings Create an Empty Knowledge Base