跳转到主要内容
POST
上传知识文件

限制说明

使用说明

  • 文件内容以 Base64 文本放在 JSON 字段 content_b64 中——不是 multipart 上传。写入已存在的 rel_path 会覆盖原文件。
  • 限制:单个文件不超过 1 MiB(DUTY.md 不超过 32 KiB),每份知识最多 100 个文件、总计 5 MiB。内容必须是不含 NUL 字节的 UTF-8 文本。超出限制或 rel_path 不合法时返回 InvalidParameter。
  • 传入 expected_version(来自上一次读取或写入)可确保期间无人修改知识时才写入;不一致时返回 HTTP 200,status 为 conflict,不写入任何内容。
  • 每次成功写入都会让知识 version 加 1;写入 DUTY.md 还会更新 duty_version。
  • 编辑账户知识需要账户 Owner 或管理员;编辑团队知识需要是该团队成员。
  • 每次调用都会记录到账户审计日志。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

要创建或覆盖的文件。文件体通过 content_b64 以 Base64 文本上传,不是 multipart 上传。

rel_path
string
必填

目标路径,相对于知识根目录;该路径已有文件时会被覆盖。必须以 / 分隔、不能以 / 开头、必须是规范化形式,且任一路径段不能为空、.、.. 或以 . 开头(不允许隐藏文件)。

pack_id
string

知识 ID;默认为调用者的账户范围知识。

content_b64
string

Base64(标准字母表)编码的文件内容。解码后必须是不含 NUL 字节的 UTF-8 文本,且不超过 1 MiB(DUTY.md 不超过 32 KiB)。不传或传空字符串则写入空文件。

content_type
string

与文件一起保存的 MIME 类型。可选:不传时按 rel_path 扩展名推断(.md → text/markdown,.yaml/.yml → text/yaml,.json → application/json,.sh → text/x-sh,其他 → text/plain)。传入的值原样保存。

expected_version
integer
默认值:0

乐观并发校验。0 或不传:无条件写入。正数:仅当知识当前 version 等于该值时才写入;否则不写入,返回 HTTP 200,status 为 conflict 并带上当前 version。

必填范围: x >= 0

响应

成功

所有 Flashduty 公开 API 共用的标准响应结构。成功时 data 为接口专属载荷且不含 error;失败时 error 存在而 data 缺失。request_id 始终存在,并会同步写入 Flashcat-Request-Id 响应头。

request_id
string
必填

本次请求的唯一 ID,与 Flashcat-Request-Id 响应头一致。反馈问题时请携带该 ID。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

响应结构中的错误 payload,仅在非 2xx 响应时出现。

data
object

写入结果。成功时包含写入的文件;版本冲突时只有 status、version 和 message。