Skip to main content
POST
Get knowledge file

Restrictions

Usage

  • Content is returned in content_b64 (base64); pack files are guaranteed UTF-8 text.
  • Omitting pack_id targets the account-scope pack; reading a team-scope pack requires team membership.
  • A missing file returns ResourceNotFound (HTTP 400).

Authorizations

app_key
string
query
required

App key issued from the Flashduty console. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Which file to fetch.

rel_path
string
required

Path of the file relative to the pack root.

pack_id
string

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

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 plus its base64-encoded content.