shared-assets

What one share link opens (public, by capability token)

The facts about the file behind one share link: its name, type, size, when it was made, who made it, and when the link stops working. A sign-in is optional and never required: send one and a member of the file's workspace is also told who can see it and whether they may change that. Carries nothing about the workspace the file came from and nothing about any other file. Answers 404 for an unknown, revoked or expired link, for a deleted file, and for a file this reader may not see, indistinguishably.

get/v1/shared-assets/{token}/meta

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/shared-assets/{token}/meta
  • Auth: one of:
    • HTTP bearer
    • none

Path parameters

tokenstring required

The share link's capability token.

Query parameters

access_acknowledgementstring uuid nullable

A UUID for one deliberate private-file opening. Reuse across requests for the same opening.

Headers

X-Share-Grantstring nullable

Response

Successful Response

is_ownerboolean

Whether the signed-in caller owns this file.

requires_access_acknowledgementboolean

Whether content requires an access_acknowledgement UUID and a durable audit receipt.

namestring required

The file's name. UNTRUSTED text: render escaped.

category'document' | 'media' | 'app' required

Which library it came from: 'document' or 'media'.

kind'app' | 'audio' | 'docx' | 'file' | 'html' | 'image' | 'markdown' | 'pdf' | 'slides' | 'spreadsheet' | 'video' required

What sort of file this is, for the icon and the preview.

content_typestring required

The current version's media type, e.g. 'application/pdf'.

byte_sizeinteger required

The current version's size in bytes.

created_atstring date-time required

When the file was made (UTC).

updated_atstring date-time required

When the file last changed (UTC).

expires_atstring date-time nullable

When this link stops working, so the page can say so before the file goes. Null only for a link minted before share links carried a deadline.

thumbnail_status'ready' | 'pending' | 'unavailable'

Whether a preview image exists for this file. 'ready' means GET /shared-assets/{token}/thumbnail serves it; 'pending' means one is being prepared, ask again shortly; 'unavailable' means the type icon is the answer.

visibility'private' | 'team' | 'external' nullable

Who can open this file, so the page can say so. Answered only for a signed-in member of the workspace that owns it; null for anyone else, because who else can read a file is not a stranger's business.

can_change_visibilityboolean

Whether YOU may change who can see this file from this page. True only when every condition PUT /assets/{id}/visibility checks for itself already holds: you are a member of this file's workspace, your session is signed in to THAT workspace, your role carries assets:edit, and you added the file or are a workspace admin. False for anyone else, so a control enabled by this flag is never refused by that request.

asset_idstring uuid nullable

This file's id, for the PUT /assets/{id}/visibility call the control above makes. Null for anyone who is not a signed-in member of the workspace that owns it.

Changes

No recorded changes to this operation across all 1 revision of this API.