Skip to main content
POST
Create a share link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Body

application/json
path
string
required

File or folder to share. The workspace root cannot be shared.

expires_hours
integer

Hours until the link expires.

max_downloads
integer

Number of downloads the link allows before it stops working.

password
string

Password required to open the link.

snapshot
boolean

Serve the bytes as they are now instead of following later edits.

allow_edit
boolean

Let recipients edit the file.

allow_comments
boolean

Let recipients comment on the file.

include_references
boolean

Include the files this file references, so embeds load.

reference_mode
enum<string>
default:dynamic

How include_references behaves. dynamic re-derives the list from the file's current contents on every access, so files it starts referencing later still load. snapshot fixes the list when the link is created. A link that allows editing is always snapshot; asking for dynamic alongside allow_edit is rejected.

Available options:
dynamic,
snapshot

Response

Successful response

The response is of type object.