AIair
Share Links

/assets/:assetId/share-links

Changed on

Create a share link for an asset.

Use followsDefaultVersion: true for a link that always shows the asset's current version, or versionId to pin the link to one version.

Any field not listed in the request body is ignored. Settings you leave out follow your workspace's share link defaults. A new link is active unless you send active: false.

password, expiresAt, requireAccount, comments and customFields depend on your workspace's plan; see the request body for what returns 422.

Returns 409 Conflict if the asset already has a link of the same kind, even a disabled one. A version has one pinned link whatever its showAllVersions setting. Older links created from inside a board don't count, so the asset can end up with more than one link that follows its current version. Use GET /v1/assets/{assetId}/share-links to find the existing link, and PATCH to change it.

Returns 403 if the link's settings, including the ones taken from your workspace defaults, would let visitors do something you can't do yourself.

Requires the share_links.write and assets.read OAuth scopes.

post/v1/assets/{assetId}/share-links

Request

Request body

OR

Response

Share link created successfully

idstring required

The share link ID. It is also the last part of url.

urlstring uri required

The public share link to give to people. It is not an Air app link and not a CDN link.

activeboolean required

Whether the link is enabled. Disabled links are still listed.

hasPasswordboolean required

Whether visitors must enter a password to open the link. The password itself is never returned.

expiresAtstring date-time nullable required

When the link stops working, or null if it never expires

requireAccountboolean required

Whether visitors must sign in to Air to open the link

allowDownloadboolean required

Whether visitors can download the original files

comments'hidden' | 'read_only' | 'allowed' required

What visitors can do with comments. hidden: they can't see comments. read_only: they can see comments but not add them. allowed: they can see and add comments, which writes to your workspace.

customFields'hidden' | 'read_only' | 'editable' required

What visitors can do with custom field values. hidden: they can't see them. read_only: they can see them. editable: they can change them, which writes to your workspace. This controls what visitors are allowed to do, not whether the Air share page shows its info panel.

createdAtstring date-time required
followsDefaultVersionboolean required

When true, the link always shows the asset's current version. When false, the link is pinned to versionId.

showAllVersionsboolean required

Whether visitors can browse the asset's other versions

versionIdstring

Present when followsDefaultVersion is false. The asset version the link is pinned to.

Changes