Skip to content

添加上传文件 ​

接口说明 ​

分批向上传会话添加 Markdown 文件,登记每个文件的相对路径、大小和可选校验值。

接口信息 ​

字段值
方法POST
路径/openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId}/entries
Operation IDaddUploadManifestEntries
鉴权Bearer OpenAPI key

入参 ​

名称位置必填类型示例说明
knowledgeBaseIdpath是stringknowledge-base-11111111-1111-4111-8111-111111111111知识库 API 返回的知识库标识。
uploadSessionIdpath是stringupload-11111111-1111-4111-8111-111111111111创建上传会话后返回的会话标识。

请求体 ​

application/json ​

字段必填类型示例说明
entries是array<UploadManifestEntryRequest>[{"relativePath":"handbook/onboarding/guide.md","declaredSize":37,"checksumSha256":"67c26271e50e79cadc720ca4eb964ee65fa4be663c87e0314b486b1109a0990c"}]本次请求添加的一个或多个 Markdown 文件记录。

请求示例 ​

bash
curl -X POST "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/upload-sessions/upload-11111111-1111-4111-8111-111111111111/entries" \
  -H "Authorization: Bearer <openapi-key>" \
  -H "Content-Type: application/json" \
  --data '{
  "entries": [
    {
      "relativePath": "handbook/onboarding/guide.md",
      "declaredSize": 37,
      "checksumSha256": "67c26271e50e79cadc720ca4eb964ee65fa4be663c87e0314b486b1109a0990c"
    }
  ]
}'

成功响应 ​

200 ​

返回接收本批文件记录后的上传会话。

字段必填类型说明
session是object当前上传会话记录。

成功响应示例 ​

json
{
  "session": {
    "id": "upload-11111111-1111-4111-8111-111111111111",
    "operationId": "upload-operation-11111111-1111-4111-8111-111111111111",
    "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
    "state": "manifest_building",
    "declaredFileCount": 1,
    "declaredByteCount": 37,
    "counts": {
      "selected": 1,
      "uploadRequired": 0,
      "skippedExisting": 0,
      "waitingReservation": 0,
      "rejectedDeleting": 0,
      "uploaded": 0,
      "finalized": 0
    },
    "errorCode": null,
    "expiresAt": "2026-06-18T00:00:00.000Z",
    "completedAt": null,
    "createdAt": "2026-06-17T00:00:00.000Z",
    "updatedAt": "2026-06-17T00:00:00.000Z",
    "actions": {
      "operation": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/operations/upload-operation-11111111-1111-4111-8111-111111111111"
    }
  }
}

错误码 ​

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

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

后续操作 ​