获取设置迁移

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#

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Path parameters

knowledge_base_idstringrequired#

知识库 ID：即知识库 API 访问 对话框中所示服务 API 端点的最后一段（…/knowledge-fs/spaces/<knowledge base ID>），也是地址栏中 /datasets/new/ 之后的那一段。

migration_idstringrequired#

迁移 ID：更新知识库设置的 202 响应中的 migration.id。其他操作都不会返回该 ID。

Responses

application/json

该迁移。

candidate_publication_fingerprintstring#

内部字段，跟踪迁移时无需使用。

changed_kindstring#

本次更改涉及的部分：embedding 或 retrieval。

checkpointstring#

已到达的最后一步：queued、candidate-built、evaluated 或 activated。要判断迁移何时结束，读取 run_state。

completed_atstring#

迁移结束（succeeded、failed 或 canceled）的时间，ISO 8601 格式。运行期间为 null。

created_atstring#

迁移开始时间，ISO 8601 格式。

error_codestring#

最近一次失败的错误码，例如 PROFILE_MIGRATION_ATTEMPTS_EXHAUSTED 或 VECTOR_SPACE_QUOTA_EXCEEDED。没有失败时为 null。

evaluation_summaryobject#

为该迁移记录的结果（扁平键值映射）。跟踪迁移时不需要此字段。未记录时为 null。

idstring#

迁移 ID，可传给获取设置迁移。

knowledge_space_idstring#

知识库的内部 ID，并非路径中的知识库 ID。

rebuild_scopestring#

迁移重建的内容：

full-vector-space：更换嵌入模型，重新嵌入所有文档。
clone-publication：更改任何检索设置，都复用当前索引。
full-page-index-summary-outline：已弃用。较早的迁移可能仍返回此值；更换推理模型时返回的是 clone-publication。

run_statestring#

迁移进度：

queued、running：进行中。
succeeded：新设置已生效。
failed：已停止，原因见 error_code。再次尝试更改前，先通过获取知识库设置检查模型。
canceled：此迁移尚未完成时，同类的新更改取代了它。改为跟踪新的迁移。

updated_atstring#

迁移最后变更时间，ISO 8601 格式。

更新知识库设置创建空知识库