Sharing API

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

8 endpoints

Endpoints

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: only RESTRICTED (a link is never made public here)
`permission`	string	New permission level: only the same or lower
`allowDownload`	boolean	Allow downloading: only turned off (never on)
`allowCopy`	boolean	Allow copying: only turned off (never on)
`requireAuth`	boolean	Require login to access: only turned on (never off)
`expiresAt`	string	New expiration: only sooner than the current one (never removed or moved later)
`password`	string	New password (a link's password is never removed here, only set or changed)

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 that a shared link was viewed or downloaded

Parameters

`shareToken`	stringrequired	Share token from the URL
`action`	stringrequired	What the visitor did: "VIEWED" or "DOWNLOADED"

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"
}'

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
}'