跳转到主要内容
POST
获取知识文件

限制说明

使用说明

  • 文件内容以 Base64 编码放在 content_b64 中返回。
  • 路径下没有文件不算错误:响应中 file 为 null、content_b64 为空,并带上当前 version。pack_id 不存在时返回 ResourceNotFound。
  • 不传 pack_id 时读取账户知识(所有成员可读);团队知识仅该团队成员可读。
  • 保留返回的 version,写回文件时作为 expected_version 传入,可避免覆盖他人的修改。

授权

app_key
string
query
必填

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

请求体

application/json

要获取的文件。

rel_path
string
必填

文件相对于知识根目录的路径。该路径下没有文件时调用仍然成功,file 为 null,content_b64 为空。

pack_id
string

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

响应

成功

所有 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

文件元数据、Base64 编码的文件内容以及当前知识版本号。