Sharing API

Create and manage share links for resources including files, flows, and bases.

9 endpoints

Endpoints

POST

/api/v1/sharing/createShare

Create a share link for a resource (file, flow, base, folder)

Parameters

`resourceType`	stringrequired	Resource type: "FILE", "FLOW", "BASE", or "FOLDER"
`resourceId`	stringrequired	ID of the resource to share
`accessType`	string	"RESTRICTED" for specific users, "ANYONE_WITH_LINK" for public
`permission`	string	Permission level
`sharedWith`	string	Email for restricted shares
`allowDownload`	boolean	Allow downloading
`allowCopy`	boolean	Allow copying
`requireAuth`	boolean	Require login to access
`expiresAt`	string	Expiration date
`password`	string	Password protection (will be hashed)

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/createShare \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "resourceType": "example",
  "resourceId": "example",
  "accessType": "example"
}'

POST

/api/v1/sharing/getResourceShares

Get all shares for a resource

Parameters

`resourceType`	stringrequired	Resource type
`resourceId`	stringrequired	Resource ID

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/getResourceShares \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "resourceType": "example",
  "resourceId": "example"
}'

POST

/api/v1/sharing/getShareByResourceId

Get share info by resource ID (public)

Parameters

`resourceType`	stringrequired	Resource type
`resourceId`	stringrequired	Resource ID

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/getShareByResourceId \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "resourceType": "example",
  "resourceId": "example"
}'

POST

/api/v1/sharing/getShareByToken

Get share info by token (public)

Parameters

`shareToken`	stringrequired	Share token from the URL
`password`	string	Password if share is protected

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/getShareByToken \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "shareToken": "example",
  "password": "example"
}'

POST

/api/v1/sharing/updateShare

Update share settings

Parameters

`shareId`	stringrequired	Share ID to update
`accessType`	string	New access type
`permission`	string	New permission level
`allowDownload`	boolean	Allow downloading
`allowCopy`	boolean	Allow copying
`requireAuth`	boolean	Require login to access
`expiresAt`	string	New expiration (null to remove)
`password`	string	New password (null to remove)

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/updateShare \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "shareId": "example",
  "accessType": "example",
  "permission": "example"
}'

POST

/api/v1/sharing/revokeShare

Revoke a share link

Parameters

shareId

stringrequired

Share ID to revoke

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/revokeShare \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "shareId": "example"
}'

POST

/api/v1/sharing/deleteShare

Permanently delete a share

Parameters

shareId

stringrequired

Share ID to delete

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/deleteShare \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "shareId": "example"
}'

POST

/api/v1/sharing/recordActivity

Record share activity (views, downloads)

Parameters

`shareToken`	stringrequired	Share token from the URL
`action`	stringrequired	Activity action type
`actorEmail`	string	Email of the viewer (if known)
`ipAddress`	string	IP address
`userAgent`	string	Browser user agent
`metadata`	object	Additional metadata

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/recordActivity \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "shareToken": "example",
  "action": "example",
  "actorEmail": "example"
}'

POST

/api/v1/sharing/getShareActivity

Get activity log for a share

Parameters

`shareId`	stringrequired	Share ID
`limit`	number	Max activities to return (1-100, default: 50)
`offset`	number	Skip activities for pagination

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/sharing/getShareActivity \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "shareId": "example",
  "limit": 0,
  "offset": 0
}'