Skip to main content
POST
Get file publish state

Restrictions

Usage

  • Use it to find out whether files produced in a session are already in the gallery, e.g. before calling /safari/artifact/gallery/publish-from-file.
  • Matching is by the file’s session and workspace path, not by the exact file_id: an older version of a republished file still reports the live artifact.
  • Files with no live artifact, and IDs that do not exist in the account, are simply absent from items; match results by the echoed file_id.

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

Probe publish state for a batch of presented files.

file_ids
string[]
required

Presented-file IDs (pf_ prefix) to check. At most 50 entries per call, counted before duplicates and empty strings are removed; more fails with InvalidParameter.

Required array length: 1 - 50 elements

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

Publish states keyed by file.