移动上传目录

接口说明

重命名或移动一个上传目录，以及其中的全部文件和子目录。

接口信息

字段	值
方法	PATCH
路径	/openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories/{directoryId}
Operation ID	moveSourceDirectory
鉴权	Bearer OpenAPI key

入参

名称	位置	必填	类型	示例	说明
knowledgeBaseId	path	是	string	knowledge-base-11111111-1111-4111-8111-111111111111	知识库 API 返回的知识库标识。
directoryId	path	是	string	directory-11111111-1111-4111-8111-111111111111	目录或文件树接口返回的上传目录标识。
Idempotency-Key	header	是	string	mutation-2026-07-10-001	客户端为请求生成的幂等键。重试同一请求时复用相同值，可以避免创建重复任务。
If-Match	header	是	string	"1"	API 返回的当前 resourceRevision。如果读取后资源又被修改，请求会返回冲突，避免覆盖较新的修改。

请求体

application/json

字段	必填	类型	示例	说明
relativePath	是	string	handbook/archive	文件在上传目录结构中的路径。

请求示例

curl -X PATCH "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/source-directories/directory-11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer <openapi-key>" \
  -H "Idempotency-Key: mutation-2026-07-10-001" \
  -H "If-Match: \"1\"" \
  -H "Content-Type: application/json" \
  --data '{
  "relativePath": "handbook/archive"
}'

成功响应

202

返回已经提交到后台处理的目录移动或重命名请求。

字段	必填	类型	说明
operation	是	object	资源变更记录。

成功响应示例

{
  "operation": {
    "operationId": "directory-move-22222222-2222-4222-8222-222222222222",
    "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
    "kind": "source_directory_move",
    "state": "processing",
    "expectedResourceRevision": 1,
    "targetKind": "source_directory",
    "targetId": "directory-11111111-1111-4111-8111-111111111111",
    "candidateRelativePath": "handbook/archive",
    "result": null,
    "errorCode": null,
    "retryGuidance": "Check this change again after a short delay.",
    "actions": {
      "self": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/operations/directory-move-22222222-2222-4222-8222-222222222222"
    },
    "createdAt": "2026-06-17T00:00:00.000Z",
    "updatedAt": "2026-06-17T00:00:00.000Z",
    "completedAt": null
  }
}

错误码

下表列出这个接口已声明的全部错误响应。

HTTP 状态	错误码	说明
401	UNAUTHORIZED	Bearer API key 缺失、格式错误、未知、已撤销或已删除。
404	NOT_FOUND	请求的资源不存在。
409	CONFLICT	请求与资源当前状态冲突。
413	PAYLOAD_TOO_LARGE	请求体或待读取文件超过当前接口允许的大小。
422	VALIDATION_ERROR	请求未通过校验。
429	RATE_LIMITED	请求超过当前配置的速率限制。
500	INTERNAL_ERROR	API 遇到内部错误。
503	DATABASE_REPOSITORY_UNAVAILABLE	当前接口所需的数据暂时不可用。

后续操作

• 获取文档索引或资源变更