> For the complete documentation index, see [llms.txt](https://academy.shade.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.shade.inc/developers/workspaces-and-drives/share-links.md).

# Share links

Share links give people outside your workspace access to a file or folder, with optional passwords, expiry dates, and view limits.

* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`. `allowed_actions` controls what visitors can do, for example `["read", "download"]`, or add `"comment"` for review links.
* List every link in a drive with `GET /workspaces/drives/{drive_id}/drive-shared-links`.

To share a hand-picked set of assets rather than a folder, use a collection instead.

See [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough.

## Get all the shares for a specific file

> Share a file on a workspace.\
> ToDo: Remove this route once Emerson deploys windows! probably in a month.\
> Do not use this route, only for backwards compatibility.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"FileSharesDTO":{"properties":{"workspace_member_inherited_role":{"$ref":"#/components/schemas/WorkspaceRole"},"drive_member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"guests":{"items":{"$ref":"#/components/schemas/UserRoleAndViaDTO"},"type":"array","title":"Guests"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"public_sharing_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Public Sharing Id"},"public_sharing_path_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Sharing Path Name"},"public_sharing_role":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]}},"type":"object","required":["workspace_member_inherited_role","drive_member_inherited_role","guests"],"title":"FileSharesDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10,0],"title":"WorkspaceRole","description":"A user's role in a workspace. Higher values grant more access."},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole","description":"A user's role on a drive, folder, or file. Higher values grant more access."},"UserRoleAndViaDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"email":{"type":"string","title":"Email"},"avatar_url":{"type":"string","title":"Avatar Url"},"user_type":{"$ref":"#/components/schemas/UserType"},"role":{"$ref":"#/components/schemas/DriveRole"},"is_contractor":{"type":"boolean","title":"Is Contractor","default":false},"is_workspace_member":{"type":"boolean","title":"Is Workspace Member","default":false},"via":{"$ref":"#/components/schemas/ViaType"}},"type":"object","required":["id","name","email","avatar_url","user_type","role","via"],"title":"UserRoleAndViaDTO"},"UserType":{"type":"string","enum":["regular","group"],"title":"UserType"},"ViaType":{"type":"string","enum":["workspace","drive","folder","direct"],"title":"ViaType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/drives/{drive_id}/file-shares":{"get":{"tags":["share-links"],"summary":"Get all the shares for a specific file","description":"Share a file on a workspace.\nToDo: Remove this route once Emerson deploys windows! probably in a month.\nDo not use this route, only for backwards compatibility.","operationId":"listFileShares","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."},{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"The directory path","format":"path"},"description":"Path of the file or folder, starting with the drive ID, for example `/7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e/Project/Interviews/A001.mov`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSharesDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Toggles public sharing on or off

> Enables or disables public links on files and folders.\
> ToDo: Remove this route once Emerson deploys windows! probably in a month.\
> Do not use this route, only for backwards compatibility.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"TogglePublicSharingRequest":{"properties":{"path":{"type":"string","format":"path","title":"The directory path","description":"Path of the file or folder, starting with the drive ID, for example `/7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e/Project/Interviews/A001.mov`."},"enable":{"type":"boolean","title":"Is public file sharing enabled or not"},"role":{"$ref":"#/components/schemas/DriveRole","title":"Role of a public viewer"}},"type":"object","required":["path","enable","role"],"title":"TogglePublicSharingRequest"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole","description":"A user's role on a drive, folder, or file. Higher values grant more access."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/drives/{drive_id}/public-link":{"post":{"tags":["share-links"],"summary":"Toggles public sharing on or off","description":"Enables or disables public links on files and folders.\nToDo: Remove this route once Emerson deploys windows! probably in a month.\nDo not use this route, only for backwards compatibility.","operationId":"togglePublicSharing","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive"},"description":"The id of the drive"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TogglePublicSharingRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get all the shared links from a drive

> Get all shared links for a drive.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"PublicShareDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"path":{"type":"string","title":"Path"},"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"is_public_enabled":{"type":"boolean","title":"Is Public Enabled"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Allowed Actions"},"password_protected":{"type":"boolean","title":"Password Protected"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"expiration_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiration Date"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"path_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"settings":{"anyOf":[{"$ref":"#/components/schemas/FileShareSettingsDTO-Output"},{"type":"null"}]},"preview_image_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Preview Image Id"},"is_expired":{"type":"boolean","title":"Is Expired","default":false},"is_view_limit_reached":{"type":"boolean","title":"Is View Limit Reached","default":false},"created_by_user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By User Id"},"max_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max View Count"},"locked":{"type":"boolean","title":"Locked","default":false},"link_sharing_template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Sharing Template Id"}},"type":"object","required":["id","path","drive_id","is_public_enabled","allowed_actions","password_protected"],"title":"PublicShareDTO"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"FileShareSettingsDTO-Output":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"FileShareSettingsDTO","description":"Display settings for a public file share (layout, visible metadata)."},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/drives/{drive_id}/drive-shared-links":{"get":{"tags":["share-links"],"summary":"Get all the shared links from a drive","description":"Get all shared links for a drive.","operationId":"listDriveShareLinks","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","description":"Column to sort by","default":"created","title":"Sort By"},"description":"Column to sort by"},{"name":"sort_order","in":"query","required":false,"schema":{"type":"string","description":"Sort direction: asc or desc","default":"desc","title":"Sort Order"},"description":"Sort direction: asc or desc"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search filter on name/path","title":"Search"},"description":"Search filter on name/path"},{"name":"actions_filter","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/Action"}},{"type":"null"}],"description":"Filter by allowed actions","title":"Actions Filter"},"description":"Filter by allowed actions"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicShareDTO"}}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get all the shares for a specific file

> Get all public shares for a specific file.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"PublicShareDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"path":{"type":"string","title":"Path"},"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"is_public_enabled":{"type":"boolean","title":"Is Public Enabled"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Allowed Actions"},"password_protected":{"type":"boolean","title":"Password Protected"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"expiration_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiration Date"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"path_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"settings":{"anyOf":[{"$ref":"#/components/schemas/FileShareSettingsDTO-Output"},{"type":"null"}]},"preview_image_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Preview Image Id"},"is_expired":{"type":"boolean","title":"Is Expired","default":false},"is_view_limit_reached":{"type":"boolean","title":"Is View Limit Reached","default":false},"created_by_user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By User Id"},"max_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max View Count"},"locked":{"type":"boolean","title":"Locked","default":false},"link_sharing_template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Sharing Template Id"}},"type":"object","required":["id","path","drive_id","is_public_enabled","allowed_actions","password_protected"],"title":"PublicShareDTO"},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"FileShareSettingsDTO-Output":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"FileShareSettingsDTO","description":"Display settings for a public file share (layout, visible metadata)."},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/drives/{drive_id}/public-file-shares":{"get":{"tags":["share-links"],"summary":"Get all the shares for a specific file","description":"Get all public shares for a specific file.","operationId":"listShareLinks","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."},{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"The directory path","format":"path"},"description":"Path of the file or folder, starting with the drive ID, for example `/7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e/Project/Interviews/A001.mov`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicShareDTO"}}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Create a public share for a specific file or folder

> Share a file on a workspace.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"CreateShareLinkRequest":{"properties":{"path":{"type":"string","format":"path","title":"The directory path","description":"Path of the file or folder, starting with the drive ID, for example `/7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e/Project/Interviews/A001.mov`."},"is_public_enabled":{"type":"boolean","title":"Whether the share is enabled","description":"Whether the share is enabled"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"The actions allowed on the share","description":"The actions allowed on the share"},"name":{"type":"string","title":"The name of the share","description":"The name of the share"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The icon of the share","description":"The icon of the share"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DriveIconType"},{"type":"null"}],"title":"The icon type of the share","description":"The icon type of the share","default":"color"},"expiration_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"The expiration date of the share","description":"The expiration date of the share"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password of the share","description":"The password of the share"},"settings":{"anyOf":[{"$ref":"#/components/schemas/FileShareSettingsDTO-Input"},{"type":"null"}],"title":"Display settings for the share","description":"View, layout, and visible metadata for the shared link"},"max_view_count":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Block after N unique viewers"},"link_sharing_template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspace link-sharing template id","description":"When set, lock state is resolved from the workspace template"}},"type":"object","required":["path","is_public_enabled","allowed_actions","name"],"title":"CreateShareLinkRequest"},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"FileShareSettingsDTO-Input":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"FileShareSettingsDTO","description":"Display settings for a public file share (layout, visible metadata)."},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"PublicShareDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"path":{"type":"string","title":"Path"},"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"is_public_enabled":{"type":"boolean","title":"Is Public Enabled"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Allowed Actions"},"password_protected":{"type":"boolean","title":"Password Protected"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"expiration_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiration Date"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"path_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"settings":{"anyOf":[{"$ref":"#/components/schemas/FileShareSettingsDTO-Output"},{"type":"null"}]},"preview_image_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Preview Image Id"},"is_expired":{"type":"boolean","title":"Is Expired","default":false},"is_view_limit_reached":{"type":"boolean","title":"Is View Limit Reached","default":false},"created_by_user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By User Id"},"max_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max View Count"},"locked":{"type":"boolean","title":"Locked","default":false},"link_sharing_template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Sharing Template Id"}},"type":"object","required":["id","path","drive_id","is_public_enabled","allowed_actions","password_protected"],"title":"PublicShareDTO"},"FileShareSettingsDTO-Output":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"FileShareSettingsDTO","description":"Display settings for a public file share (layout, visible metadata)."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/drives/{drive_id}/public-file-shares":{"post":{"tags":["share-links"],"summary":"Create a public share for a specific file or folder","description":"Share a file on a workspace.","operationId":"createShareLink","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShareLinkRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicShareDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Update a public share for a specific file or folder

> Update a public share for a specific file or folder.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UpdateShareLinkRequest":{"properties":{"is_public_enabled":{"type":"boolean","title":"Whether the share is enabled","description":"Whether the share is enabled"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"The actions allowed on the share","description":"The actions allowed on the share"},"name":{"type":"string","title":"The name of the share","description":"The name of the share","default":""},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The icon of the share","description":"The icon of the share"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DriveIconType"},{"type":"null"}],"title":"The icon type of the share","description":"The icon type of the share","default":"color"},"expiration_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"The expiration date of the share","description":"The expiration date of the share"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password of the share","description":"The password of the share"},"removed_password":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Removed password","description":"remove the public link password","default":false},"settings":{"anyOf":[{"$ref":"#/components/schemas/FileShareSettingsDTO-Input"},{"type":"null"}],"title":"Display settings for the share","description":"View, layout, and visible metadata for the shared link"},"max_view_count":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Block after N unique viewers"}},"type":"object","required":["is_public_enabled","allowed_actions"],"title":"UpdateShareLinkRequest"},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"FileShareSettingsDTO-Input":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"FileShareSettingsDTO","description":"Display settings for a public file share (layout, visible metadata)."},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/drives/{drive_id}/public-file-shares/{share_id}":{"put":{"tags":["share-links"],"summary":"Update a public share for a specific file or folder","description":"Update a public share for a specific file or folder.","operationId":"updateShareLink","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."},{"name":"share_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The share id"},"description":"ID of the share link, from `listShareLinks` or the `id` returned when you create one."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShareLinkRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"null"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Delete a public share for a specific file or folder

> Share a file on a workspace.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/drives/{drive_id}/public-file-shares/{share_id}":{"delete":{"tags":["share-links"],"summary":"Delete a public share for a specific file or folder","description":"Share a file on a workspace.","operationId":"deleteShareLink","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."},{"name":"share_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The share id"},"description":"ID of the share link, from `listShareLinks` or the `id` returned when you create one."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"null"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get share data

> Return the contents of the folder -> an array of AssetDTO

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"PublishDataDTO":{"properties":{"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"role":{"$ref":"#/components/schemas/DriveRole"},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"is_file":{"type":"boolean","title":"Is File","default":false},"is_folder":{"type":"boolean","title":"Is Folder","default":false},"root_path":{"type":"string","title":"Root Path"},"path":{"type":"string","title":"Path"},"preview_image_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Preview Image Id"},"preview_video_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Preview Video Id"},"password_protected":{"type":"boolean","title":"Password Protected","default":false},"settings":{"anyOf":[{"$ref":"#/components/schemas/FileShareSettingsDTO-Output"},{"type":"null"}]}},"type":"object","title":"PublishDataDTO"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole","description":"A user's role on a drive, folder, or file. Higher values grant more access."},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"FileShareSettingsDTO-Output":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"FileShareSettingsDTO","description":"Display settings for a public file share (layout, visible metadata)."},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/shares/{share_id}":{"get":{"tags":["share-links"],"summary":"Get share data","description":"Return the contents of the folder -> an array of AssetDTO","operationId":"getShareLink","parameters":[{"name":"share_id","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the share link, from `listShareLinks` or the `id` returned when you create one."},{"name":"path","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path under share"},"description":"Path of the file or folder, starting with the drive ID, for example `/7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e/Project/Interviews/A001.mov`."}],"responses":{"200":{"description":"Share data includes drive_id, role, actions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishDataDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /workspaces/public-file-shares/{share\_id}/email

> Invite a user to a public share

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"share-links","description":"Share links give people outside your workspace access to a file or folder,\nwith optional passwords, expiry dates, and view limits.\n\n* Create a link with `POST /workspaces/drives/{drive_id}/public-file-shares`.\n  `allowed_actions` controls what visitors can do, for example\n  `[\"read\", \"download\"]`, or add `\"comment\"` for review links.\n* List every link in a drive with\n  `GET /workspaces/drives/{drive_id}/drive-shared-links`.\n\nTo share a hand-picked set of assets rather than a folder, use a\ncollection instead.\n\nSee [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links) for a walkthrough."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"EmailShareLinkRequest":{"properties":{"email":{"type":"string","title":"The email of the user to invite"},"message":{"type":"string","title":"The message to send to the user"},"link":{"type":"string","title":"The link to the public share"}},"type":"object","required":["email","message","link"],"title":"EmailShareLinkRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/public-file-shares/{share_id}/email":{"post":{"tags":["share-links"],"summary":"Invite a user to a public share","operationId":"emailShareLink","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailShareLinkRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"null"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"parameters":[{"name":"share_id","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the share link, from `listShareLinks` or the `id` returned when you create one."}]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.shade.inc/developers/workspaces-and-drives/share-links.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
