Skip to main content
POST
Get knowledge file

Restrictions

Usage

  • Content is returned base64-encoded in content_b64.
  • A path with no file is not an error: the response has file = null, an empty content_b64, and the current version. An unknown pack_id returns ResourceNotFound.
  • Omitting pack_id targets the account knowledge (readable by every member); team knowledge is readable only by members of that team.
  • Keep the returned version and pass it as expected_version when writing the file back, to avoid overwriting someone else’s change.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Which file to fetch.

rel_path
string
required

Path of the file relative to the knowledge root. If no file exists at this path, the call still succeeds with file set to null and an empty content_b64.

pack_id
string

Knowledge ID; defaults to the caller's account-scope knowledge.

Response

Success

Standard response envelope used by every Flashduty public API. On success data contains the endpoint-specific payload and error is absent. On failure error is present and data is absent. request_id is always present and is also mirrored in the Flashcat-Request-Id response header.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

Error payload inside the response envelope. Present only on non-2xx responses.

data
object

File metadata, its base64-encoded content, and the current knowledge version.