fileshare
File Shares: durable single-file share links. create/list/details/update/delete, per-user grants (grant-list/grant-add/grant-revoke incl. grant-by-email with pending invites), and direct read/preview/version URLs. Call action='describe' for the full action/param reference. Bound to ONE workspace file (immutable binding); deletion NEVER touches the bound file. Recipient 404 is UNIFORM — not-found / revoked / expired are indistinguishable by design (do not speculate). Passwords are supplied via the x-ve-password header (the password input) — never placed in URLs. Destructive: delete (removes the share, not the file). Reversible access change: grant-revoke (re-grantable). download-url / preview-url / version-download-url return a DIRECT API URL — gated shares require Authorization and/or x-ve-password HEADERS on the GET (the password is never embedded in the URL).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| node | No | create: the workspace FILE node opaque ID to bind the share to (required). The binding is immutable — share a different file by creating a new File Share. | |
| user | No | grant-add / grant-revoke: the grantee's numeric user ID (19-digit). EXACTLY ONE of user / email. | |
| No | grant-add / grant-revoke: the grantee's email. EXACTLY ONE of user / email. An unregistered email becomes a PENDING invite (auto-activates on signup; capped to the share's expiry). | ||
| limit | No | list: page size (1-500, default 100). | |
| title | No | Human-readable share title. create / update. | |
| action | Yes | Operation. Use 'describe' for full action reference. | |
| offset | No | list: pagination offset (default 0). | |
| expires | No | create/update: relative expiry in SECONDS from now (1..3155760000). Mutually exclusive with expires_at. | |
| password | No | create/update: SET the share password. On consumer actions (details / download-url / preview-url / versions-list / version-download-url): supply the recipient password — forwarded ONLY as the x-ve-password header, never in a URL/log. update: send '' (empty string) to CLEAR an existing password. | |
| capability | No | grant-add: the capability to grant — view | download | edit (ordered). `edit` allows content write-back. Required for grant-add. | |
| expires_at | No | create/update: absolute expiry as 'YYYY-MM-DD HH:MM:SS UTC' (no timezone = UTC). Mutually exclusive with expires. update: send '' (empty string) to CLEAR the expiry and make the share durable again. | |
| version_id | No | version-download-url: the specific version OpaqueId to download (from versions-list / details). | |
| fileshare_id | No | File Share ID (19-digit numeric). Required for every action except create / list. | |
| preview_type | No | preview-url: the preview variant (e.g. 'image', 'pdf', 'video'). Multi-file previews 307-redirect to a token-bearing sub-file URL. | |
| workspace_id | No | Parent workspace ID (19-digit or custom name). create / list — the management authz anchor. | |
| access_option | No | Access tier: anyone_with_link | any_registered | named_people. create / update. `edit` capability is NEVER conferred by a tier — it always needs an explicit edit grant. |