# Workspaces

## Get the metadata attributes for a drive including system attributes

> Get the metadata attributes for a drive including system attributes

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/metadata":{"get":{"tags":["workspaces","drives","drives"],"summary":"Get the metadata attributes for a drive including system attributes","description":"Get the metadata attributes for a drive including system attributes","operationId":"get_drive_metadata_route_workspaces_drives__drive_id__metadata_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_drive_metadata_route_workspaces_drives__drive_id__metadata_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MetadataAttribute-Output"},"title":"Response Get Drive Metadata Route Workspaces Drives  Drive Id  Metadata Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_drive_metadata_route_workspaces_drives__drive_id__metadata_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_drive_metadata_route_workspaces_drives__drive_id__metadata_get"},"MetadataAttribute-Output":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"keys":{"items":{"type":"string"},"type":"array","title":"Keys"},"value_type":{"$ref":"#/components/schemas/MetadataAttributeType"},"description":{"type":"string","title":"Description"},"location":{"$ref":"#/components/schemas/MetadataAttributeLocation"},"default":{"anyOf":[{},{"type":"null"}],"title":"Default"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetadataAttributeSelectOption"},"type":"array"},{"type":"null"}],"title":"Options"},"add_new_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add New Options","default":true},"restrict_to_types":{"anyOf":[{"items":{"$ref":"#/components/schemas/AssetType"},"type":"array"},{"type":"null"}],"title":"Restrict To Types"},"automated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Automated","default":false},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","default":false},"locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Locked","default":false}},"type":"object","required":["id","name","keys","value_type","description","location"],"title":"MetadataAttribute"},"MetadataAttributeType":{"type":"string","enum":["str","single_select","multi_select","float","int","bool","datetime","rating"],"title":"MetadataAttributeType"},"MetadataAttributeLocation":{"type":"string","enum":["system","custom","asset"],"title":"MetadataAttributeLocation"},"MetadataAttributeSelectOption":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"color":{"$ref":"#/components/schemas/MetadataAttributeSelectOptionColor"},"user":{"type":"boolean","title":"User"},"archived":{"type":"boolean","title":"Archived","default":false}},"type":"object","required":["id","name","color","user"],"title":"MetadataAttributeSelectOption"},"MetadataAttributeSelectOptionColor":{"type":"string","enum":["pink","red","yellow","light_green","dark_green","light_blue","dark_blue","purple"],"title":"MetadataAttributeSelectOptionColor"},"AssetType":{"type":"string","enum":["IMAGE","VIDEO","AUDIO","DOCUMENT","HDR","HDRI","PHOTOSHOP","ILLUSTRATOR","EXR","OBJECT","VECTOR","OTHER","MAYA","MAX","BLENDER","HOUDINI","UNREAL","UNITY","AFTER_EFFECTS","MOGRT"],"title":"AssetType"},"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"}}}}
```

## POST /workspaces/drives/{drive\_id}/metadata

> Add metadata attributes to a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/metadata":{"post":{"tags":["workspaces","drives","drives"],"summary":"Add metadata attributes to a drive","operationId":"add_drive_metadata_workspaces_drives__drive_id__metadata_post","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_add_drive_metadata_workspaces_drives__drive_id__metadata_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataAttribute-Output"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_add_drive_metadata_workspaces_drives__drive_id__metadata_post":{"properties":{"metadata":{"$ref":"#/components/schemas/MetadataAttribute-Input","title":"The metadata attributes","description":"The metadata attributes to add to the drive"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["metadata"],"title":"Body_add_drive_metadata_workspaces_drives__drive_id__metadata_post"},"MetadataAttribute-Input":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"keys":{"items":{"type":"string"},"type":"array","title":"Keys"},"value_type":{"$ref":"#/components/schemas/MetadataAttributeType"},"description":{"type":"string","title":"Description"},"location":{"$ref":"#/components/schemas/MetadataAttributeLocation"},"default":{"anyOf":[{},{"type":"null"}],"title":"Default"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetadataAttributeSelectOption"},"type":"array"},{"type":"null"}],"title":"Options"},"add_new_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add New Options","default":true},"restrict_to_types":{"anyOf":[{"items":{"$ref":"#/components/schemas/AssetType"},"type":"array"},{"type":"null"}],"title":"Restrict To Types"},"automated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Automated","default":false},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","default":false},"locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Locked","default":false}},"type":"object","required":["id","name","keys","value_type","description","location"],"title":"MetadataAttribute"},"MetadataAttributeType":{"type":"string","enum":["str","single_select","multi_select","float","int","bool","datetime","rating"],"title":"MetadataAttributeType"},"MetadataAttributeLocation":{"type":"string","enum":["system","custom","asset"],"title":"MetadataAttributeLocation"},"MetadataAttributeSelectOption":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"color":{"$ref":"#/components/schemas/MetadataAttributeSelectOptionColor"},"user":{"type":"boolean","title":"User"},"archived":{"type":"boolean","title":"Archived","default":false}},"type":"object","required":["id","name","color","user"],"title":"MetadataAttributeSelectOption"},"MetadataAttributeSelectOptionColor":{"type":"string","enum":["pink","red","yellow","light_green","dark_green","light_blue","dark_blue","purple"],"title":"MetadataAttributeSelectOptionColor"},"AssetType":{"type":"string","enum":["IMAGE","VIDEO","AUDIO","DOCUMENT","HDR","HDRI","PHOTOSHOP","ILLUSTRATOR","EXR","OBJECT","VECTOR","OTHER","MAYA","MAX","BLENDER","HOUDINI","UNREAL","UNITY","AFTER_EFFECTS","MOGRT"],"title":"AssetType"},"MetadataAttribute-Output":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"keys":{"items":{"type":"string"},"type":"array","title":"Keys"},"value_type":{"$ref":"#/components/schemas/MetadataAttributeType"},"description":{"type":"string","title":"Description"},"location":{"$ref":"#/components/schemas/MetadataAttributeLocation"},"default":{"anyOf":[{},{"type":"null"}],"title":"Default"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetadataAttributeSelectOption"},"type":"array"},{"type":"null"}],"title":"Options"},"add_new_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add New Options","default":true},"restrict_to_types":{"anyOf":[{"items":{"$ref":"#/components/schemas/AssetType"},"type":"array"},{"type":"null"}],"title":"Restrict To Types"},"automated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Automated","default":false},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","default":false},"locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Locked","default":false}},"type":"object","required":["id","name","keys","value_type","description","location"],"title":"MetadataAttribute"},"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"}}}}
```

## POST /workspaces/drives/{drive\_id}/metadata/{metadata\_id}

> Archive metadata attribute on a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/metadata/{metadata_id}":{"post":{"tags":["workspaces","drives","drives"],"summary":"Archive metadata attribute on a drive","operationId":"archive_metadata_attribute_workspaces_drives__drive_id__metadata__metadata_id__post","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"metadata_id","in":"path","required":true,"schema":{"type":"string","title":"The metadata id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_archive_metadata_attribute_workspaces_drives__drive_id__metadata__metadata_id__post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_archive_metadata_attribute_workspaces_drives__drive_id__metadata__metadata_id__post":{"properties":{"archive":{"type":"boolean","title":"Archive metadata attribute or not","description":"Archive metadata attribute or not"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["archive"],"title":"Body_archive_metadata_attribute_workspaces_drives__drive_id__metadata__metadata_id__post"},"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"}}}}
```

## PUT /workspaces/drives/{drive\_id}/metadata/{metadata\_id}

> Update a metadata attribute on a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/metadata/{metadata_id}":{"put":{"tags":["workspaces","drives","drives"],"summary":"Update a metadata attribute on a drive","operationId":"update_metadata_attribute_workspaces_drives__drive_id__metadata__metadata_id__put","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"metadata_id","in":"path","required":true,"schema":{"type":"string","title":"The metadata id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_metadata_attribute_workspaces_drives__drive_id__metadata__metadata_id__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataAttribute-Output"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_update_metadata_attribute_workspaces_drives__drive_id__metadata__metadata_id__put":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The metadata name","description":"The metadata name to update"},"automated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"The metadata automated","description":"The metadata automated to update"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The metadata prompt","description":"The metadata prompt to update"},"default":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The metadata default","description":"The metadata default to update"},"add_new_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add new options","description":"Whether or not we're allowed to add new options"},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetadataAttributeSelectOption"},"type":"array"},{"type":"null"}],"title":"The metadata options","description":"The metadata options to update"},"rerun":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rerun AI","description":"Whether or not to rerun the AI on all cells including existing ones","default":false},"locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Locked","description":"Whether or not the metadata attribute is locked to managers only"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_update_metadata_attribute_workspaces_drives__drive_id__metadata__metadata_id__put"},"MetadataAttributeSelectOption":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"color":{"$ref":"#/components/schemas/MetadataAttributeSelectOptionColor"},"user":{"type":"boolean","title":"User"},"archived":{"type":"boolean","title":"Archived","default":false}},"type":"object","required":["id","name","color","user"],"title":"MetadataAttributeSelectOption"},"MetadataAttributeSelectOptionColor":{"type":"string","enum":["pink","red","yellow","light_green","dark_green","light_blue","dark_blue","purple"],"title":"MetadataAttributeSelectOptionColor"},"MetadataAttribute-Output":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"keys":{"items":{"type":"string"},"type":"array","title":"Keys"},"value_type":{"$ref":"#/components/schemas/MetadataAttributeType"},"description":{"type":"string","title":"Description"},"location":{"$ref":"#/components/schemas/MetadataAttributeLocation"},"default":{"anyOf":[{},{"type":"null"}],"title":"Default"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetadataAttributeSelectOption"},"type":"array"},{"type":"null"}],"title":"Options"},"add_new_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add New Options","default":true},"restrict_to_types":{"anyOf":[{"items":{"$ref":"#/components/schemas/AssetType"},"type":"array"},{"type":"null"}],"title":"Restrict To Types"},"automated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Automated","default":false},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","default":false},"locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Locked","default":false}},"type":"object","required":["id","name","keys","value_type","description","location"],"title":"MetadataAttribute"},"MetadataAttributeType":{"type":"string","enum":["str","single_select","multi_select","float","int","bool","datetime","rating"],"title":"MetadataAttributeType"},"MetadataAttributeLocation":{"type":"string","enum":["system","custom","asset"],"title":"MetadataAttributeLocation"},"AssetType":{"type":"string","enum":["IMAGE","VIDEO","AUDIO","DOCUMENT","HDR","HDRI","PHOTOSHOP","ILLUSTRATOR","EXR","OBJECT","VECTOR","OTHER","MAYA","MAX","BLENDER","HOUDINI","UNREAL","UNITY","AFTER_EFFECTS","MOGRT"],"title":"AssetType"},"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"}}}}
```

## POST /workspaces/drives/{drive\_id}/metadata/{metadata\_id}/option

> Create a metadata attribute option on a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/metadata/{metadata_id}/option":{"post":{"tags":["workspaces","drives","drives"],"summary":"Create a metadata attribute option on a drive","operationId":"create_metadata_attribute_option_workspaces_drives__drive_id__metadata__metadata_id__option_post","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"metadata_id","in":"path","required":true,"schema":{"type":"string","title":"The metadata id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_metadata_attribute_option_workspaces_drives__drive_id__metadata__metadata_id__option_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataAttributeSelectOption"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_create_metadata_attribute_option_workspaces_drives__drive_id__metadata__metadata_id__option_post":{"properties":{"option_name":{"type":"string","title":"The option name","description":"The option name to add to the metadata attribute"},"option_color":{"$ref":"#/components/schemas/MetadataAttributeSelectOptionColor","title":"The option color","description":"The option color to add to the metadata attribute"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["option_name","option_color"],"title":"Body_create_metadata_attribute_option_workspaces_drives__drive_id__metadata__metadata_id__option_post"},"MetadataAttributeSelectOptionColor":{"type":"string","enum":["pink","red","yellow","light_green","dark_green","light_blue","dark_blue","purple"],"title":"MetadataAttributeSelectOptionColor"},"MetadataAttributeSelectOption":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"color":{"$ref":"#/components/schemas/MetadataAttributeSelectOptionColor"},"user":{"type":"boolean","title":"User"},"archived":{"type":"boolean","title":"Archived","default":false}},"type":"object","required":["id","name","color","user"],"title":"MetadataAttributeSelectOption"},"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"}}}}
```

## Shares a file (or folder) w user

> Share a file on a workspace.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/share-file":{"post":{"tags":["workspaces","drives"],"summary":"Shares a file (or folder) w user","description":"Share a file on a workspace.","operationId":"share_file_workspaces_drives__drive_id__share_file_post","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_share_file_workspaces_drives__drive_id__share_file_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Share File Workspaces Drives  Drive Id  Share File Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_share_file_workspaces_drives__drive_id__share_file_post":{"properties":{"path":{"type":"string","format":"path","title":"The directory path","description":"The directory path of the file to share"},"invites":{"items":{"$ref":"#/components/schemas/PathInvite"},"type":"array","title":"The workspace invitations","description":"A combination of email and role for the user to invite to the workspace"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The url","description":"The url of the file"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The message","description":"The message to send to the invited users","default":""},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["path","invites"],"title":"Body_share_file_workspaces_drives__drive_id__share_file_post"},"PathInvite":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"role":{"$ref":"#/components/schemas/DriveRole"}},"type":"object","required":["email","role"],"title":"PathInvite"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"}}}}
```

## 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","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/file-shares":{"get":{"tags":["workspaces","drives"],"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":"get_file_shares_workspaces_drives__drive_id__file_shares_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"The directory path","description":"The directory path to list items","format":"path"},"description":"The directory path to list items"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_file_shares_workspaces_drives__drive_id__file_shares_get"}}}},"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"}}}}}}}},"components":{"schemas":{"Body_get_file_shares_workspaces_drives__drive_id__file_shares_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_file_shares_workspaces_drives__drive_id__file_shares_get"},"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],"title":"WorkspaceRole"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"},"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"}}}}
```

## Get all files shared with a user

> Get all files shared with a user on a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/shared":{"get":{"tags":["workspaces","drives"],"summary":"Get all files shared with a user","description":"Get all files shared with a user on a drive","operationId":"get_files_shared_with_user_on_drive_workspaces_drives__drive_id__shared_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_files_shared_with_user_on_drive_workspaces_drives__drive_id__shared_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserSharesDTO"},"title":"Response Get Files Shared With User On Drive Workspaces Drives  Drive Id  Shared Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_files_shared_with_user_on_drive_workspaces_drives__drive_id__shared_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_files_shared_with_user_on_drive_workspaces_drives__drive_id__shared_get"},"UserSharesDTO":{"properties":{"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"drive_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Drive Identifier"},"id":{"type":"string","format":"uuid","title":"Id"},"asset":{"anyOf":[{"$ref":"#/components/schemas/AssetDTO"},{"type":"null"}]},"path":{"type":"string","title":"Path"},"role":{"type":"integer","title":"Role"},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"}},"type":"object","required":["drive_id","id","path","role","actions"],"title":"UserSharesDTO"},"AssetDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"path":{"type":"string","title":"Path"},"name":{"type":"string","title":"Name"},"extension":{"type":"string","title":"Extension"},"updated":{"type":"string","format":"date-time","title":"Updated"},"created":{"type":"string","format":"date-time","title":"Created"},"type":{"$ref":"#/components/schemas/AssetType"},"size_bytes":{"type":"integer","title":"Size Bytes"},"stack_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Stack Id"},"stack_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stack Number"},"is_fs_draft_blob":{"type":"boolean","title":"Is Fs Draft Blob"},"is_fs_null_blob":{"type":"boolean","title":"Is Fs Null Blob"},"rating":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rating"},"ai_indexed":{"type":"boolean","title":"Ai Indexed"},"system_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"System Metadata","default":{}},"custom_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Metadata","default":{}},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"palette":{"items":{"items":{"type":"integer"},"type":"array"},"type":"array","title":"Palette"},"ocr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocr"},"transcription_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transcription Id"},"faces_present":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Faces Present"},"content_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Content Length"},"preview_job_state":{"$ref":"#/components/schemas/JobState"},"metadata_job_state":{"$ref":"#/components/schemas/JobState"},"core_vision_job_state":{"$ref":"#/components/schemas/JobState"},"color_palette_job_state":{"$ref":"#/components/schemas/JobState"},"core_audio_job_state":{"$ref":"#/components/schemas/JobState"},"audio_job_state":{"$ref":"#/components/schemas/JobState"},"facial_recognition_job_state":{"$ref":"#/components/schemas/JobState"},"proxy_job_state":{"$ref":"#/components/schemas/JobState"},"audio_proxy_job_state":{"$ref":"#/components/schemas/JobState"},"transcription_job_state":{"$ref":"#/components/schemas/JobState"},"objects":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Objects"},"texture_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Texture Data"},"integration_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Integration Data"},"preview_images":{"items":{"$ref":"#/components/schemas/PreviewDTO"},"type":"array","title":"Preview Images"},"custom_thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}]},"proxy":{"anyOf":[{"$ref":"#/components/schemas/ProxyDTO"},{"type":"null"}]},"audio_proxy":{"anyOf":[{"$ref":"#/components/schemas/ProxyDTO"},{"type":"null"}]}},"type":"object","required":["id","drive_id","path","name","extension","updated","created","type","size_bytes","is_fs_draft_blob","is_fs_null_blob","ai_indexed","palette","preview_job_state","metadata_job_state","core_vision_job_state","color_palette_job_state","core_audio_job_state","facial_recognition_job_state","proxy_job_state","audio_proxy_job_state","transcription_job_state","preview_images"],"title":"AssetDTO","description":"Full asset DTO with relationship fields that require eager loading."},"AssetType":{"type":"string","enum":["IMAGE","VIDEO","AUDIO","DOCUMENT","HDR","HDRI","PHOTOSHOP","ILLUSTRATOR","EXR","OBJECT","VECTOR","OTHER","MAYA","MAX","BLENDER","HOUDINI","UNREAL","UNITY","AFTER_EFFECTS","MOGRT"],"title":"AssetType"},"JobState":{"type":"string","enum":["NOT_STARTED","IN_PROGRESS","COMPLETED","FAILED","INSUFFICIENT_CREDITS"],"title":"JobState","description":"Enum for asset job states"},"PreviewDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"frame":{"type":"integer","title":"Frame"},"signed_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signed Url"}},"type":"object","required":["id","frame"],"title":"PreviewDTO"},"ProxyDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"ProxyDTO"},"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"},"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"}}}}
```

## DELETE /workspaces/drives/{drive\_id}/shared/{user\_id}/path

> Removes a share from a path

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/shared/{user_id}/path":{"delete":{"tags":["workspaces","drives"],"summary":"Removes a share from a path","operationId":"remove_share_workspaces_drives__drive_id__shared__user_id__path_delete","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user id to remove from path"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_remove_share_workspaces_drives__drive_id__shared__user_id__path_delete"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Remove Share Workspaces Drives  Drive Id  Shared  User Id  Path Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_remove_share_workspaces_drives__drive_id__shared__user_id__path_delete":{"properties":{"path":{"type":"string","format":"path","title":"The directory path","description":"The directory path to list items"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["path"],"title":"Body_remove_share_workspaces_drives__drive_id__shared__user_id__path_delete"},"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"}}}}
```

## PUT /workspaces/drives/{drive\_id}/users/{user\_id}/path

> Updates people's permissions on a path

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/users/{user_id}/path":{"put":{"tags":["workspaces","drives"],"summary":"Updates people's permissions on a path","operationId":"update_path_permissions_workspaces_drives__drive_id__users__user_id__path_put","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user id to update"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_path_permissions_workspaces_drives__drive_id__users__user_id__path_put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_update_path_permissions_workspaces_drives__drive_id__users__user_id__path_put":{"properties":{"role":{"$ref":"#/components/schemas/DriveRole","title":"The role to update"},"path":{"type":"string","format":"path","title":"The path to change permissions"},"upsert":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"If the user hasn't been shared the file, share it","default":false},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["role","path"],"title":"Body_update_path_permissions_workspaces_drives__drive_id__users__user_id__path_put"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"}}}}
```

## 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","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/public-link":{"post":{"tags":["workspaces","drives"],"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":"toggle_public_file_sharing_workspaces_drives__drive_id__public_link_post","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"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_toggle_public_file_sharing_workspaces_drives__drive_id__public_link_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Toggle Public File Sharing Workspaces Drives  Drive Id  Public Link Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_toggle_public_file_sharing_workspaces_drives__drive_id__public_link_post":{"properties":{"path":{"type":"string","format":"path","title":"The directory path","description":"The directory path to list items"},"enable":{"type":"boolean","title":"Is public file sharing enabled or not"},"role":{"$ref":"#/components/schemas/DriveRole","title":"Role of a public viewer"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["path","enable","role"],"title":"Body_toggle_public_file_sharing_workspaces_drives__drive_id__public_link_post"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"}}}}
```

## GET /workspaces/drives/{drive\_id}/file-users

> Lists all the user for a specific path (file or folder).

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/file-users":{"get":{"tags":["workspaces","drives"],"summary":"Lists all the user for a specific path (file or folder).","operationId":"list_path_users_workspaces_drives__drive_id__file_users_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"The directory path","format":"path"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_path_users_workspaces_drives__drive_id__file_users_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUsersDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_path_users_workspaces_drives__drive_id__file_users_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_path_users_workspaces_drives__drive_id__file_users_get"},"FileUsersDTO":{"properties":{"invited":{"items":{"$ref":"#/components/schemas/UserRoleViaAndMembershipDTO"},"type":"array","title":"Invited"},"not_invited":{"items":{"$ref":"#/components/schemas/FileGuestDTO"},"type":"array","title":"Not Invited"}},"type":"object","required":["invited","not_invited"],"title":"FileUsersDTO"},"UserRoleViaAndMembershipDTO":{"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"},"via":{"$ref":"#/components/schemas/ViaType"},"is_contractor":{"type":"boolean","title":"Is Contractor","default":false},"is_workspace_member":{"type":"boolean","title":"Is Workspace Member","default":false},"is_inheriting_as_workspace_member":{"type":"boolean","title":"Is Inheriting As Workspace Member","default":false},"is_pending":{"type":"boolean","title":"Is Pending","default":false}},"type":"object","required":["id","name","email","avatar_url","user_type","role","via"],"title":"UserRoleViaAndMembershipDTO"},"UserType":{"type":"string","enum":["regular","group"],"title":"UserType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"ViaType":{"type":"string","enum":["workspace","drive","folder","direct"],"title":"ViaType"},"FileGuestDTO":{"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"}},"type":"object","required":["id","name","email","avatar_url","user_type","role"],"title":"FileGuestDTO"},"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"}}}}
```

## Get your role + actions you can do on a folder (or file if you pass a path)

> Get your role + actions you can do on a file (asset).\
> No need to auth these bc you are checking your role and would get none if you don't have auth.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/folder-permissions":{"get":{"tags":["workspaces","drives"],"summary":"Get your role + actions you can do on a folder (or file if you pass a path)","description":"Get your role + actions you can do on a file (asset).\nNo need to auth these bc you are checking your role and would get none if you don't have auth.","operationId":"get_folder_allowed_actions_workspaces_drives__drive_id__folder_permissions_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The Drive id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"The directory path","description":"The directory path to list items","format":"path"},"description":"The directory path to list items"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_folder_allowed_actions_workspaces_drives__drive_id__folder_permissions_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UserRoleAndActionsDTO"},{"type":"null"}],"title":"Response Get Folder Allowed Actions Workspaces Drives  Drive Id  Folder Permissions Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_folder_allowed_actions_workspaces_drives__drive_id__folder_permissions_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_folder_allowed_actions_workspaces_drives__drive_id__folder_permissions_get"},"UserRoleAndActionsDTO":{"properties":{"role":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"via":{"anyOf":[{"$ref":"#/components/schemas/ViaType"},{"type":"null"}]}},"type":"object","required":["role","actions","via"],"title":"UserRoleAndActionsDTO"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"},"ViaType":{"type":"string","enum":["workspace","drive","folder","direct"],"title":"ViaType"},"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"}}}}
```

## Get your role + actions you can do on an asset

> Get your role + actions you can do on a file (asset).\
> No need to auth these bc you are checking your role and would get none if you don't have auth.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/file-permissions":{"get":{"tags":["workspaces","drives"],"summary":"Get your role + actions you can do on an asset","description":"Get your role + actions you can do on a file (asset).\nNo need to auth these bc you are checking your role and would get none if you don't have auth.","operationId":"get_file_allowed_actions_workspaces_drives__drive_id__file_permissions_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The Drive id"}},{"name":"asset_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The id of the file (asset id)","description":"The id of the file (asset id)"},"description":"The id of the file (asset id)"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_file_allowed_actions_workspaces_drives__drive_id__file_permissions_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UserRoleAndActionsDTO"},{"type":"null"}],"title":"Response Get File Allowed Actions Workspaces Drives  Drive Id  File Permissions Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_file_allowed_actions_workspaces_drives__drive_id__file_permissions_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_file_allowed_actions_workspaces_drives__drive_id__file_permissions_get"},"UserRoleAndActionsDTO":{"properties":{"role":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"via":{"anyOf":[{"$ref":"#/components/schemas/ViaType"},{"type":"null"}]}},"type":"object","required":["role","actions","via"],"title":"UserRoleAndActionsDTO"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"},"ViaType":{"type":"string","enum":["workspace","drive","folder","direct"],"title":"ViaType"},"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"}}}}
```

## Authorize path

> Check whether a user is authed on a path in a drive.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/authorize":{"get":{"tags":["workspaces","drives"],"summary":"Authorize path","description":"Check whether a user is authed on a path in a drive.","operationId":"auth_path_route_workspaces_drives__drive_id__authorize_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"The directory path","description":"The directory path to authorize","format":"path"},"description":"The directory path to authorize"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_auth_path_route_workspaces_drives__drive_id__authorize_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Auth Path Route Workspaces Drives  Drive Id  Authorize Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_auth_path_route_workspaces_drives__drive_id__authorize_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_auth_path_route_workspaces_drives__drive_id__authorize_get"},"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"}}}}
```

## Lists all the paths for a specific workspace

> For drive and workspace users, list their access and paths.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/user-paths":{"get":{"tags":["workspaces","drives"],"summary":"Lists all the paths for a specific workspace","description":"For drive and workspace users, list their access and paths.","operationId":"list_user_path_access_drives_workspaces_drives__drive_id__user_paths_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrivePath"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DrivePath":{"properties":{"drive":{"$ref":"#/components/schemas/DriveDTO"},"paths":{"items":{"$ref":"#/components/schemas/PathAccess"},"type":"array","title":"Paths"}},"type":"object","required":["drive","paths"],"title":"DrivePath"},"DriveDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend"],"title":"DriveDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"PathAccess":{"properties":{"user_id":{"type":"string","format":"uuid","title":"User Id"},"user_name":{"type":"string","title":"User Name"},"path":{"type":"string","title":"Path"},"role":{"$ref":"#/components/schemas/DriveRole"}},"type":"object","required":["user_id","user_name","path","role"],"title":"PathAccess"},"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"}}}}
```

## Lists all the paths for a user in a specific drive

> Lists all the paths for a specific user on a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/user-paths/{user_id}":{"get":{"tags":["workspaces","drives"],"summary":"Lists all the paths for a user in a specific drive","description":"Lists all the paths for a specific user on a drive","operationId":"list_user_path_access_on_drive_workspaces_drives__drive_id__user_paths__user_id__get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_user_path_access_on_drive_workspaces_drives__drive_id__user_paths__user_id__get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrivePath"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_user_path_access_on_drive_workspaces_drives__drive_id__user_paths__user_id__get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_user_path_access_on_drive_workspaces_drives__drive_id__user_paths__user_id__get"},"DrivePath":{"properties":{"drive":{"$ref":"#/components/schemas/DriveDTO"},"paths":{"items":{"$ref":"#/components/schemas/PathAccess"},"type":"array","title":"Paths"}},"type":"object","required":["drive","paths"],"title":"DrivePath"},"DriveDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend"],"title":"DriveDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"PathAccess":{"properties":{"user_id":{"type":"string","format":"uuid","title":"User Id"},"user_name":{"type":"string","title":"User Name"},"path":{"type":"string","title":"Path"},"role":{"$ref":"#/components/schemas/DriveRole"}},"type":"object","required":["user_id","user_name","path","role"],"title":"PathAccess"},"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"}}}}
```

## GET /workspaces/drives/{drive\_id}/users

> Lists all the user for a specific drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/users":{"get":{"tags":["workspaces","drives"],"summary":"Lists all the user for a specific drive","operationId":"list_drive_users_workspaces_drives__drive_id__users_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_drive_users_workspaces_drives__drive_id__users_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/DriveUserDTO"}},{"type":"null"}],"title":"Response List Drive Users Workspaces Drives  Drive Id  Users Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_drive_users_workspaces_drives__drive_id__users_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_drive_users_workspaces_drives__drive_id__users_get"},"DriveUserDTO":{"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"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"joined":{"type":"string","format":"date-time","title":"Joined"},"role":{"$ref":"#/components/schemas/DriveRole"},"is_workspace_member":{"type":"boolean","title":"Is Workspace Member","default":false},"is_workspace_owner":{"type":"boolean","title":"Is Workspace Owner","default":false},"is_inherited_manager":{"type":"boolean","title":"Is Inherited Manager","default":false},"is_contractor":{"type":"boolean","title":"Is Contractor","default":false}},"type":"object","required":["id","name","email","avatar_url","user_type","external_id","joined","role"],"title":"DriveUserDTO"},"UserType":{"type":"string","enum":["regular","group"],"title":"UserType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"}}}}
```

## POST /workspaces/drives/{drive\_id}/send-invites

> Sends invites for user to join a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/send-invites":{"post":{"tags":["workspaces","drives"],"summary":"Sends invites for user to join a drive","operationId":"invite_users_to_drive_workspaces_drives__drive_id__send_invites_post","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_invite_users_to_drive_workspaces_drives__drive_id__send_invites_post"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response Invite Users To Drive Workspaces Drives  Drive Id  Send Invites Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_invite_users_to_drive_workspaces_drives__drive_id__send_invites_post":{"properties":{"invites":{"items":{"$ref":"#/components/schemas/DriveInvite"},"type":"array","title":"The workspace invitations","description":"A combination of email and role for the user to invite to the workspace"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invite message"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["invites","message"],"title":"Body_invite_users_to_drive_workspaces_drives__drive_id__send_invites_post"},"DriveInvite":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"role":{"$ref":"#/components/schemas/DriveRole"}},"type":"object","required":["email","role"],"title":"DriveInvite"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"}}}}
```

## Gets a drive from the drive\_id

> Gets a drive from the drive\_id

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}":{"get":{"tags":["workspaces"],"summary":"Gets a drive from the drive_id","description":"Gets a drive from the drive_id","operationId":"get_workspace_drive_workspaces_drives__drive_id__get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_workspace_drive_workspaces_drives__drive_id__get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriveWithActionsDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_workspace_drive_workspaces_drives__drive_id__get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_workspace_drive_workspaces_drives__drive_id__get"},"DriveWithActionsDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"role":{"$ref":"#/components/schemas/DriveRole"},"is_workspace_member":{"type":"boolean","title":"Is Workspace Member","default":false}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend","actions","role"],"title":"DriveWithActionsDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"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"},"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"}}}}
```

## PUT /workspaces/drives/{drive\_id}

> Updates drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}":{"put":{"tags":["workspaces","drives"],"summary":"Updates drive","operationId":"update_drive_workspaces_drives__drive_id__put","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_drive_workspaces_drives__drive_id__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriveWithActionsDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_update_drive_workspaces_drives__drive_id__put":{"properties":{"name":{"type":"string","title":"Drive Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Drive Icon"},"icon_type":{"$ref":"#/components/schemas/DriveIconType","title":"Drive Icon"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole","title":"Member Inherited Role"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["name","description","icon","icon_type","member_inherited_role"],"title":"Body_update_drive_workspaces_drives__drive_id__put"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveWithActionsDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"role":{"$ref":"#/components/schemas/DriveRole"},"is_workspace_member":{"type":"boolean","title":"Is Workspace Member","default":false}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend","actions","role"],"title":"DriveWithActionsDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"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"},"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"}}}}
```

## DELETE /workspaces/drives/{drive\_id}

> Delete a drive by drive\_id

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}":{"delete":{"tags":["workspaces","drives"],"summary":"Delete a drive by drive_id","operationId":"delete_drive_workspaces_drives__drive_id__delete","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_delete_drive_workspaces_drives__drive_id__delete"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Drive Workspaces Drives  Drive Id  Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_delete_drive_workspaces_drives__drive_id__delete":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_delete_drive_workspaces_drives__drive_id__delete"},"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"}}}}
```

## PUT /workspaces/drives/{drive\_id}/users/{user\_id}

> Updates people's permissions on a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/users/{user_id}":{"put":{"tags":["workspaces","drives"],"summary":"Updates people's permissions on a drive","operationId":"update_drive_permissions_workspaces_drives__drive_id__users__user_id__put","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user id to update"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_drive_permissions_workspaces_drives__drive_id__users__user_id__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_update_drive_permissions_workspaces_drives__drive_id__users__user_id__put":{"properties":{"role":{"$ref":"#/components/schemas/DriveRole","title":"The role to update"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["role"],"title":"Body_update_drive_permissions_workspaces_drives__drive_id__users__user_id__put"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"}}}}
```

## DELETE /workspaces/drives/{drive\_id}/users/{user\_id}

> Removes a user from a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/users/{user_id}":{"delete":{"tags":["workspaces","drives"],"summary":"Removes a user from a drive","operationId":"remove_user_from_drive_workspaces_drives__drive_id__users__user_id__delete","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user id"}},{"name":"only_remove_direct_access","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Only remove direct access","default":false}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_remove_user_from_drive_workspaces_drives__drive_id__users__user_id__delete"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Remove User From Drive Workspaces Drives  Drive Id  Users  User Id  Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_remove_user_from_drive_workspaces_drives__drive_id__users__user_id__delete":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_remove_user_from_drive_workspaces_drives__drive_id__users__user_id__delete"},"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"}}}}
```

## GET /workspaces/drives/{drive\_id}/shade-fs-token

> Get a signed JWT for a specific drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/shade-fs-token":{"get":{"tags":["workspaces","drives"],"summary":"Get a signed JWT for a specific drive","operationId":"get_shade_fs_token_workspaces_drives__drive_id__shade_fs_token_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The Drive id"}},{"name":"machine_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine ID","description":"The machine ID to embed into the JWT"},"description":"The machine ID to embed into the JWT"},{"name":"share_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Share ID","description":"If provided, only include this specific share path in the token"},"description":"If provided, only include this specific share path in the token"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_shade_fs_token_workspaces_drives__drive_id__shade_fs_token_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_shade_fs_token_workspaces_drives__drive_id__shade_fs_token_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_shade_fs_token_workspaces_drives__drive_id__shade_fs_token_get"},"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"}}}}
```

## GET /workspaces/drives/{drive\_id}/shade-message-bus-token

> Get a signed JWT for Shade Message Bus for a specific drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/shade-message-bus-token":{"get":{"tags":["workspaces","drives"],"summary":"Get a signed JWT for Shade Message Bus for a specific drive","operationId":"get_shade_message_bus_token_for_drive_workspaces_drives__drive_id__shade_message_bus_token_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Drive Id"}},{"name":"share_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Share id","description":"If user not authenticated, a share id must be passed for a publish path"},"description":"If user not authenticated, a share id must be passed for a publish path"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_shade_message_bus_token_for_drive_workspaces_drives__drive_id__shade_message_bus_token_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_shade_message_bus_token_for_drive_workspaces_drives__drive_id__shade_message_bus_token_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_shade_message_bus_token_for_drive_workspaces_drives__drive_id__shade_message_bus_token_get"},"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"}}}}
```

## Get all the shared links from a drive

> Get all shared links for a drive.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/drive-shared-links":{"get":{"tags":["workspaces","drives"],"summary":"Get all the shared links from a drive","description":"Get all shared links for a drive.","operationId":"get_drives_shared_links_workspaces_drives__drive_id__drive_shared_links_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_drives_shared_links_workspaces_drives__drive_id__drive_shared_links_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicShareDTO"},"title":"Response Get Drives Shared Links Workspaces Drives  Drive Id  Drive Shared Links Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_drives_shared_links_workspaces_drives__drive_id__drive_shared_links_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_drives_shared_links_workspaces_drives__drive_id__drive_shared_links_get"},"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"},"is_expired":{"type":"boolean","title":"Is Expired","default":false}},"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"},"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"}}}}
```

## Get all the shares for a specific file

> Get all public shares for a specific file.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/public-file-shares":{"get":{"tags":["workspaces","drives"],"summary":"Get all the shares for a specific file","description":"Get all public shares for a specific file.","operationId":"get_public_file_shares_workspaces_drives__drive_id__public_file_shares_get","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"The directory path","description":"The directory path to list items","format":"path"},"description":"The directory path to list items"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_public_file_shares_workspaces_drives__drive_id__public_file_shares_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicShareDTO"},"title":"Response Get Public File Shares Workspaces Drives  Drive Id  Public File Shares Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_public_file_shares_workspaces_drives__drive_id__public_file_shares_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_public_file_shares_workspaces_drives__drive_id__public_file_shares_get"},"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"},"is_expired":{"type":"boolean","title":"Is Expired","default":false}},"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"},"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"}}}}
```

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

> Share a file on a workspace.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/public-file-shares":{"post":{"tags":["workspaces","drives"],"summary":"Create a public share for a specific file or folder","description":"Share a file on a workspace.","operationId":"create_public_file_shares_workspaces_drives__drive_id__public_file_shares_post","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_public_file_shares_workspaces_drives__drive_id__public_file_shares_post"}}}},"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"}}}}}}}},"components":{"schemas":{"Body_create_public_file_shares_workspaces_drives__drive_id__public_file_shares_post":{"properties":{"path":{"type":"string","format":"path","title":"The directory path","description":"The directory path to list items"},"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"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["path","is_public_enabled","allowed_actions","name"],"title":"Body_create_public_file_shares_workspaces_drives__drive_id__public_file_shares_post"},"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"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"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"},"is_expired":{"type":"boolean","title":"Is Expired","default":false}},"type":"object","required":["id","path","drive_id","is_public_enabled","allowed_actions","password_protected"],"title":"PublicShareDTO"},"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"}}}}
```

## 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","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/public-file-shares/{share_id}":{"put":{"tags":["workspaces","drives"],"summary":"Update a public share for a specific file or folder","description":"Update a public share for a specific file or folder.","operationId":"update_public_file_share_workspaces_drives__drive_id__public_file_shares__share_id__put","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"share_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The share id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_public_file_share_workspaces_drives__drive_id__public_file_shares__share_id__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_update_public_file_share_workspaces_drives__drive_id__public_file_shares__share_id__put":{"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},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["is_public_enabled","allowed_actions"],"title":"Body_update_public_file_share_workspaces_drives__drive_id__public_file_shares__share_id__put"},"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"},"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"}}}}
```

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

> Share a file on a workspace.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/public-file-shares/{share_id}":{"delete":{"tags":["workspaces","drives"],"summary":"Delete a public share for a specific file or folder","description":"Share a file on a workspace.","operationId":"delete_public_file_share_workspaces_drives__drive_id__public_file_shares__share_id__delete","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"share_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The share id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_delete_public_file_share_workspaces_drives__drive_id__public_file_shares__share_id__delete"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_delete_public_file_share_workspaces_drives__drive_id__public_file_shares__share_id__delete":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_delete_public_file_share_workspaces_drives__drive_id__public_file_shares__share_id__delete"},"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"}}}}
```

## PUT /workspaces/drives/{drive\_id}/settings

> Update drive settings

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drives/{drive_id}/settings":{"put":{"tags":["workspaces","drives"],"summary":"Update drive settings","operationId":"update_drive_settings_workspaces_drives__drive_id__settings_put","parameters":[{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriveSettingsPatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DriveSettingsPatch":{"properties":{"max_storage_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","title":"DriveSettingsPatch"},"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"}}}}
```

## GET /workspaces

> Lists all the workspaces for that user based on permissions

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces":{"get":{"tags":["workspaces"],"summary":"Lists all the workspaces for that user based on permissions","operationId":"list_workspaces_workspaces_get","parameters":[{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_workspaces_workspaces_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceListDTO"},"title":"Response List Workspaces Workspaces Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_workspaces_workspaces_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_workspaces_workspaces_get"},"WorkspaceListDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"member_inherited_role":{"$ref":"#/components/schemas/WorkspaceRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"type":{"$ref":"#/components/schemas/WorkspaceType"},"onboarding":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Onboarding"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"personal":{"type":"boolean","title":"Personal"},"role":{"$ref":"#/components/schemas/WorkspaceRole"}},"type":"object","required":["id","name","description","domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","organization","client_metadata","actions","personal","role"],"title":"WorkspaceListDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"WorkspaceType":{"type":"string","enum":["PERSONAL","TEAM"],"title":"WorkspaceType"},"WorkspaceSettings":{"properties":{"transcription_model":{"$ref":"#/components/schemas/TranscriptionModelType"},"default_drive_inheritance":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]}},"type":"object","required":["transcription_model"],"title":"WorkspaceSettings"},"TranscriptionModelType":{"type":"string","enum":["BEST","NANO"],"title":"TranscriptionModelType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"OrganizationDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"url_subdomain":{"type":"string","title":"Url Subdomain"},"email_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Domain"},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partnership_type":{"anyOf":[{"$ref":"#/components/schemas/PartnershipType"},{"type":"null"}]},"discount_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Discount Amount"}},"type":"object","required":["id","name","url_subdomain","email_domain","client_metadata","partnership_type","discount_amount"],"title":"OrganizationDTO"},"PartnershipType":{"type":"string","enum":["BRANDING","DISCOUNT","CONTRACT"],"title":"PartnershipType"},"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"},"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"}}}}
```

## Creates a workspace

> Create a workspace.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces":{"post":{"tags":["workspaces"],"summary":"Creates a workspace","description":"Create a workspace.","operationId":"create_workspace_workspaces_post","parameters":[{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_workspace_workspaces_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_create_workspace_workspaces_post":{"properties":{"url_subdomain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url subdomain if workspace is created under an organization"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Workspace description"},"team_size_analytics":{"type":"string","title":"Team Size"},"team_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Domain"},"team_usage_analytics":{"type":"string","title":"How will you use shade"},"data_types_analytics":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Data types"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Picture","description":"The profile picture's link to image"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain of workspace","description":"Custom domain for the workspae"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["name","description","team_size_analytics","team_usage_analytics"],"title":"Body_create_workspace_workspaces_post"},"WorkspaceDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"member_inherited_role":{"$ref":"#/components/schemas/WorkspaceRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"type":{"$ref":"#/components/schemas/WorkspaceType"},"onboarding":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Onboarding"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"}},"type":"object","required":["id","name","description","domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","organization","client_metadata"],"title":"WorkspaceDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"WorkspaceType":{"type":"string","enum":["PERSONAL","TEAM"],"title":"WorkspaceType"},"WorkspaceSettings":{"properties":{"transcription_model":{"$ref":"#/components/schemas/TranscriptionModelType"},"default_drive_inheritance":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]}},"type":"object","required":["transcription_model"],"title":"WorkspaceSettings"},"TranscriptionModelType":{"type":"string","enum":["BEST","NANO"],"title":"TranscriptionModelType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"OrganizationDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"url_subdomain":{"type":"string","title":"Url Subdomain"},"email_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Domain"},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partnership_type":{"anyOf":[{"$ref":"#/components/schemas/PartnershipType"},{"type":"null"}]},"discount_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Discount Amount"}},"type":"object","required":["id","name","url_subdomain","email_domain","client_metadata","partnership_type","discount_amount"],"title":"OrganizationDTO"},"PartnershipType":{"type":"string","enum":["BRANDING","DISCOUNT","CONTRACT"],"title":"PartnershipType"},"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"}}}}
```

## GET /workspaces/{workspace\_id}/drives

> Lists all the drives for a specific workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/drives":{"get":{"tags":["workspaces"],"summary":"Lists all the drives for a specific workspace","operationId":"list_workspace_drives_workspaces__workspace_id__drives_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_workspace_drives_workspaces__workspace_id__drives_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriveWithActionsDTO"},"title":"Response List Workspace Drives Workspaces  Workspace Id  Drives Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_workspace_drives_workspaces__workspace_id__drives_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_workspace_drives_workspaces__workspace_id__drives_get"},"DriveWithActionsDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"role":{"$ref":"#/components/schemas/DriveRole"},"is_workspace_member":{"type":"boolean","title":"Is Workspace Member","default":false}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend","actions","role"],"title":"DriveWithActionsDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"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"},"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"}}}}
```

## Creates a drive in a workspace

> Create a Drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/drives":{"post":{"tags":["workspaces"],"summary":"Creates a drive in a workspace","description":"Create a Drive","operationId":"create_workspace_drive_workspaces__workspace_id__drives_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_workspace_drive_workspaces__workspace_id__drives_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriveWithActionsDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_create_workspace_drive_workspaces__workspace_id__drives_post":{"properties":{"name":{"type":"string","title":"Drive Name"},"description":{"type":"string","title":"Drive Description"},"type":{"$ref":"#/components/schemas/DriveType","title":"Drive Type"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Drive Icon"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DriveIconType"},{"type":"null"}],"title":"Drive Icon Type"},"byos":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"BYOS Info"},"default_storage_backend":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Default Provider info"},"template_drive_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Template Drive"},"public_template_key":{"anyOf":[{"$ref":"#/components/schemas/PublicDriveTemplate"},{"type":"null"}],"title":"Public Template Key"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["name","description","type","icon_type"],"title":"Body_create_workspace_drive_workspaces__workspace_id__drives_post"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"PublicDriveTemplate":{"type":"string","enum":["video_production","commercial_photography","marketing_agency"],"title":"PublicDriveTemplate"},"DriveWithActionsDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"role":{"$ref":"#/components/schemas/DriveRole"},"is_workspace_member":{"type":"boolean","title":"Is Workspace Member","default":false}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend","actions","role"],"title":"DriveWithActionsDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"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"},"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"}}}}
```

## Lists all user drives (including demo workspace drives)

> This route is used to get all the drives for a user.\
> The frontend uses this to determine which shadefs drives should be kept/removed

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/drive-ids":{"get":{"tags":["workspaces"],"summary":"Lists all user drives (including demo workspace drives)","description":"This route is used to get all the drives for a user.\nThe frontend uses this to determine which shadefs drives should be kept/removed","operationId":"list_all_user_drives_workspaces_drive_ids_get","parameters":[{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_all_user_drives_workspaces_drive_ids_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response List All User Drives Workspaces Drive Ids Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_all_user_drives_workspaces_drive_ids_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_all_user_drives_workspaces_drive_ids_get"},"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"}}}}
```

## Lists all the paths for a user in a specific workspace

> Lists all the paths for a specific user on a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/user-paths/{user_id}":{"get":{"tags":["workspaces"],"summary":"Lists all the paths for a user in a specific workspace","description":"Lists all the paths for a specific user on a workspace","operationId":"list_user_path_access_on_workspace_workspaces__workspace_id__user_paths__user_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_user_path_access_on_workspace_workspaces__workspace_id__user_paths__user_id__get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DrivePath"},"title":"Response List User Path Access On Workspace Workspaces  Workspace Id  User Paths  User Id  Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_user_path_access_on_workspace_workspaces__workspace_id__user_paths__user_id__get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_user_path_access_on_workspace_workspaces__workspace_id__user_paths__user_id__get"},"DrivePath":{"properties":{"drive":{"$ref":"#/components/schemas/DriveDTO"},"paths":{"items":{"$ref":"#/components/schemas/PathAccess"},"type":"array","title":"Paths"}},"type":"object","required":["drive","paths"],"title":"DrivePath"},"DriveDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend"],"title":"DriveDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"PathAccess":{"properties":{"user_id":{"type":"string","format":"uuid","title":"User Id"},"user_name":{"type":"string","title":"User Name"},"path":{"type":"string","title":"Path"},"role":{"$ref":"#/components/schemas/DriveRole"}},"type":"object","required":["user_id","user_name","path","role"],"title":"PathAccess"},"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"}}}}
```

## Lists all the paths for a specific workspace

> For drive and workspace users, list their access and paths.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/user-paths":{"get":{"tags":["workspaces"],"summary":"Lists all the paths for a specific workspace","description":"For drive and workspace users, list their access and paths.","operationId":"list_user_path_access_workspaces_workspaces__workspace_id__user_paths_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_user_path_access_workspaces_workspaces__workspace_id__user_paths_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DrivePath"},"title":"Response List User Path Access Workspaces Workspaces  Workspace Id  User Paths Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_user_path_access_workspaces_workspaces__workspace_id__user_paths_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_user_path_access_workspaces_workspaces__workspace_id__user_paths_get"},"DrivePath":{"properties":{"drive":{"$ref":"#/components/schemas/DriveDTO"},"paths":{"items":{"$ref":"#/components/schemas/PathAccess"},"type":"array","title":"Paths"}},"type":"object","required":["drive","paths"],"title":"DrivePath"},"DriveDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend"],"title":"DriveDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"PathAccess":{"properties":{"user_id":{"type":"string","format":"uuid","title":"User Id"},"user_name":{"type":"string","title":"User Name"},"path":{"type":"string","title":"Path"},"role":{"$ref":"#/components/schemas/DriveRole"}},"type":"object","required":["user_id","user_name","path","role"],"title":"PathAccess"},"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"}}}}
```

## POST /workspaces{workspace\_id}/credits

> Gets the # of available credits on a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces{workspace_id}/credits":{"post":{"tags":["workspaces"],"summary":"Gets the # of available credits on a workspace","operationId":"get_available_credits_workspaces_workspace_id__credits_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_available_credits_workspaces_workspace_id__credits_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Get Available Credits Workspaces Workspace Id  Credits Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_available_credits_workspaces_workspace_id__credits_post":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_available_credits_workspaces_workspace_id__credits_post"},"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"}}}}
```

## Lists all the drives and your permission level for them

> This is used for the /admin routes

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/drives/permissions":{"get":{"tags":["workspaces"],"summary":"Lists all the drives and your permission level for them","description":"This is used for the /admin routes","operationId":"list_workspace_drives_with_permissions_workspaces__workspace_id__drives_permissions_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_workspace_drives_with_permissions_workspaces__workspace_id__drives_permissions_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrivePermissionsDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_workspace_drives_with_permissions_workspaces__workspace_id__drives_permissions_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_workspace_drives_with_permissions_workspaces__workspace_id__drives_permissions_get"},"DrivePermissionsDTO":{"properties":{"drives_you_can_manage":{"items":{"$ref":"#/components/schemas/DriveDTO"},"type":"array","title":"Drives You Can Manage"},"drives_you_can_read":{"items":{"$ref":"#/components/schemas/DriveDTO"},"type":"array","title":"Drives You Can Read"}},"type":"object","required":["drives_you_can_manage","drives_you_can_read"],"title":"DrivePermissionsDTO"},"DriveDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend"],"title":"DriveDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"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"}}}}
```

## GET /workspaces/{workspace\_id}/users

> Lists all the users for a specific workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/users":{"get":{"tags":["workspaces"],"summary":"Lists all the users for a specific workspace","operationId":"list_workspace_users_workspaces__workspace_id__users_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_list_workspace_users_workspaces__workspace_id__users_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceUserDTO"},"title":"Response List Workspace Users Workspaces  Workspace Id  Users Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_list_workspace_users_workspaces__workspace_id__users_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_list_workspace_users_workspaces__workspace_id__users_get"},"WorkspaceUserDTO":{"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"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"joined":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Joined"},"role":{"$ref":"#/components/schemas/WorkspaceRole"},"is_workspace_member":{"type":"boolean","title":"Is Workspace Member","default":false},"is_workspace_owner":{"type":"boolean","title":"Is Workspace Owner","default":false},"is_contractor":{"type":"boolean","title":"Is Contractor","default":false}},"type":"object","required":["id","name","email","avatar_url","user_type","external_id","role"],"title":"WorkspaceUserDTO"},"UserType":{"type":"string","enum":["regular","group"],"title":"UserType"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"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"}}}}
```

## GET /workspaces/{workspace\_id}/users/count

> Lists count of all the users for a specific workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/users/count":{"get":{"tags":["workspaces"],"summary":"Lists count of all the users for a specific workspace","operationId":"get_workspace_user_count_route_workspaces__workspace_id__users_count_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_workspace_user_count_route_workspaces__workspace_id__users_count_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUserCountDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_workspace_user_count_route_workspaces__workspace_id__users_count_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_workspace_user_count_route_workspaces__workspace_id__users_count_get"},"WorkspaceUserCountDTO":{"properties":{"total_count":{"type":"integer","title":"Total Count"},"member_count":{"type":"integer","title":"Member Count"},"guest_count":{"type":"integer","title":"Guest Count"},"admin_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Admin Count"}},"type":"object","required":["total_count","member_count","guest_count"],"title":"WorkspaceUserCountDTO"},"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"}}}}
```

## Gets a workspace from the workspace\_id

> Gets a workspace from the workspace\_id

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}":{"get":{"tags":["workspaces"],"summary":"Gets a workspace from the workspace_id","description":"Gets a workspace from the workspace_id","operationId":"get_workspace_workspaces__workspace_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_workspace_workspaces__workspace_id__get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceListDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_workspace_workspaces__workspace_id__get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_workspace_workspaces__workspace_id__get"},"WorkspaceListDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"member_inherited_role":{"$ref":"#/components/schemas/WorkspaceRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"type":{"$ref":"#/components/schemas/WorkspaceType"},"onboarding":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Onboarding"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Actions"},"personal":{"type":"boolean","title":"Personal"},"role":{"$ref":"#/components/schemas/WorkspaceRole"}},"type":"object","required":["id","name","description","domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","organization","client_metadata","actions","personal","role"],"title":"WorkspaceListDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"WorkspaceType":{"type":"string","enum":["PERSONAL","TEAM"],"title":"WorkspaceType"},"WorkspaceSettings":{"properties":{"transcription_model":{"$ref":"#/components/schemas/TranscriptionModelType"},"default_drive_inheritance":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]}},"type":"object","required":["transcription_model"],"title":"WorkspaceSettings"},"TranscriptionModelType":{"type":"string","enum":["BEST","NANO"],"title":"TranscriptionModelType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"OrganizationDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"url_subdomain":{"type":"string","title":"Url Subdomain"},"email_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Domain"},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partnership_type":{"anyOf":[{"$ref":"#/components/schemas/PartnershipType"},{"type":"null"}]},"discount_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Discount Amount"}},"type":"object","required":["id","name","url_subdomain","email_domain","client_metadata","partnership_type","discount_amount"],"title":"OrganizationDTO"},"PartnershipType":{"type":"string","enum":["BRANDING","DISCOUNT","CONTRACT"],"title":"PartnershipType"},"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"},"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"}}}}
```

## Updates a workspace

> Update a workspace.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}":{"put":{"tags":["workspaces"],"summary":"Updates a workspace","description":"Update a workspace.","operationId":"update_workspace_workspaces__workspace_id__put","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_workspace_workspaces__workspace_id__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_update_workspace_workspaces__workspace_id__put":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspace Name"},"domain":{"anyOf":[{"type":"string","pattern":"^[a-zA-Z0-9.-]+$"},{"type":"null"}],"title":"Workspace Domain"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"team_size_analytics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Size"},"team_usage_analytics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"How will you use shade"},"data_types_analytics":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Data types"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Picture","description":"The profile picture's byte array"},"onboarding_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onboarding Key","description":"Workspace onboarding key to set as finished"},"client_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Client metadata","description":"set client metadata"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_update_workspace_workspaces__workspace_id__put"},"WorkspaceDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"member_inherited_role":{"$ref":"#/components/schemas/WorkspaceRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"type":{"$ref":"#/components/schemas/WorkspaceType"},"onboarding":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Onboarding"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"}},"type":"object","required":["id","name","description","domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","organization","client_metadata"],"title":"WorkspaceDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"WorkspaceType":{"type":"string","enum":["PERSONAL","TEAM"],"title":"WorkspaceType"},"WorkspaceSettings":{"properties":{"transcription_model":{"$ref":"#/components/schemas/TranscriptionModelType"},"default_drive_inheritance":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]}},"type":"object","required":["transcription_model"],"title":"WorkspaceSettings"},"TranscriptionModelType":{"type":"string","enum":["BEST","NANO"],"title":"TranscriptionModelType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"OrganizationDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"url_subdomain":{"type":"string","title":"Url Subdomain"},"email_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Domain"},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partnership_type":{"anyOf":[{"$ref":"#/components/schemas/PartnershipType"},{"type":"null"}]},"discount_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Discount Amount"}},"type":"object","required":["id","name","url_subdomain","email_domain","client_metadata","partnership_type","discount_amount"],"title":"OrganizationDTO"},"PartnershipType":{"type":"string","enum":["BRANDING","DISCOUNT","CONTRACT"],"title":"PartnershipType"},"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"}}}}
```

## DELETE /workspaces/{workspace\_id}

> Deletes a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}":{"delete":{"tags":["workspaces"],"summary":"Deletes a workspace","operationId":"delete_workspace_workspaces__workspace_id__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_delete_workspace_workspaces__workspace_id__delete"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Workspace Workspaces  Workspace Id  Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_delete_workspace_workspaces__workspace_id__delete":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_delete_workspace_workspaces__workspace_id__delete"},"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"}}}}
```

## POST /workspaces/avatar/upload-url

> Create an avatar for a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/avatar/upload-url":{"post":{"tags":["workspaces"],"summary":"Create an avatar for a workspace","operationId":"workspace_create_avatar_upload_url_workspaces_avatar_upload_url_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_workspace_create_avatar_upload_url_workspaces_avatar_upload_url_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Workspace Create Avatar Upload Url Workspaces Avatar Upload Url Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_workspace_create_avatar_upload_url_workspaces_avatar_upload_url_post":{"properties":{"extension":{"type":"string","enum":["png","jpg","jpeg"],"title":"Extension","description":"The extension type of the avatar"},"size":{"title":"Size","description":"Size of the avatar"}},"type":"object","required":["extension","size"],"title":"Body_workspace_create_avatar_upload_url_workspaces_avatar_upload_url_post"},"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"}}}}
```

## POST /workspaces/{workspace\_id}/avatar/complete

> Confirm uploading an avatar for a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/avatar/complete":{"post":{"tags":["workspaces"],"summary":"Confirm uploading an avatar for a workspace","operationId":"workspace_complete_avatar_workspaces__workspace_id__avatar_complete_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_workspace_complete_avatar_workspaces__workspace_id__avatar_complete_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_workspace_complete_avatar_workspaces__workspace_id__avatar_complete_post":{"properties":{"download_url":{"title":"Download url","description":"The download url"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["download_url"],"title":"Body_workspace_complete_avatar_workspaces__workspace_id__avatar_complete_post"},"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"}}}}
```

## POST /workspaces/{workspace\_id}/send-invites

> Sends invites for user to join a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/send-invites":{"post":{"tags":["workspaces"],"summary":"Sends invites for user to join a workspace","operationId":"invite_people_to_workspace_workspaces__workspace_id__send_invites_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_invite_people_to_workspace_workspaces__workspace_id__send_invites_post"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Invite People To Workspace Workspaces  Workspace Id  Send Invites Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_invite_people_to_workspace_workspaces__workspace_id__send_invites_post":{"properties":{"invites":{"items":{"$ref":"#/components/schemas/WorkspaceInvite"},"type":"array","title":"The workspace invitations","description":"A combination of email and role for the user to invite to the workspace"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The invite message","description":"The message to send to the invited user"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["invites","message"],"title":"Body_invite_people_to_workspace_workspaces__workspace_id__send_invites_post"},"WorkspaceInvite":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"role":{"$ref":"#/components/schemas/WorkspaceRole"}},"type":"object","required":["email","role"],"title":"WorkspaceInvite"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"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"}}}}
```

## Gets data for a specific invitation

> This is a PUBLIC route where anyone can see invites. To see (you've been invited to ... workspace)

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/invites/{invite_id}":{"get":{"tags":["workspaces"],"summary":"Gets data for a specific invitation","description":"This is a PUBLIC route where anyone can see invites. To see (you've been invited to ... workspace)","operationId":"get_invite_data_workspaces_invites__invite_id__get","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invite ID"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceInviteDTO"},{"$ref":"#/components/schemas/DriveInviteDTO"},{"type":"null"}],"title":"Response Get Invite Data Workspaces Invites  Invite Id  Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"WorkspaceInviteDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"sent_by":{"anyOf":[{"$ref":"#/components/schemas/UserDTOBase"},{"type":"null"}]},"sent_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Sent By Id"},"sent_to_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sent To Email"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"workspace":{"$ref":"#/components/schemas/WorkspaceDTO"},"workspace_role":{"$ref":"#/components/schemas/WorkspaceRole"},"invite_type":{"$ref":"#/components/schemas/InviteType"},"invite_target":{"$ref":"#/components/schemas/InviteTarget"}},"type":"object","required":["id","sent_by","sent_by_id","sent_to_email","workspace_id","workspace","workspace_role","invite_type","invite_target"],"title":"WorkspaceInviteDTO"},"UserDTOBase":{"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"}},"type":"object","required":["id","name","email","avatar_url","user_type"],"title":"UserDTOBase"},"UserType":{"type":"string","enum":["regular","group"],"title":"UserType"},"WorkspaceDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"member_inherited_role":{"$ref":"#/components/schemas/WorkspaceRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"type":{"$ref":"#/components/schemas/WorkspaceType"},"onboarding":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Onboarding"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"}},"type":"object","required":["id","name","description","domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","organization","client_metadata"],"title":"WorkspaceDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"WorkspaceType":{"type":"string","enum":["PERSONAL","TEAM"],"title":"WorkspaceType"},"WorkspaceSettings":{"properties":{"transcription_model":{"$ref":"#/components/schemas/TranscriptionModelType"},"default_drive_inheritance":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]}},"type":"object","required":["transcription_model"],"title":"WorkspaceSettings"},"TranscriptionModelType":{"type":"string","enum":["BEST","NANO"],"title":"TranscriptionModelType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"OrganizationDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"url_subdomain":{"type":"string","title":"Url Subdomain"},"email_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Domain"},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partnership_type":{"anyOf":[{"$ref":"#/components/schemas/PartnershipType"},{"type":"null"}]},"discount_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Discount Amount"}},"type":"object","required":["id","name","url_subdomain","email_domain","client_metadata","partnership_type","discount_amount"],"title":"OrganizationDTO"},"PartnershipType":{"type":"string","enum":["BRANDING","DISCOUNT","CONTRACT"],"title":"PartnershipType"},"InviteType":{"type":"string","enum":["drive","workspace","item"],"title":"InviteType"},"InviteTarget":{"type":"string","enum":["user","anyone"],"title":"InviteTarget"},"DriveInviteDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"sent_by":{"anyOf":[{"$ref":"#/components/schemas/UserDTOBase"},{"type":"null"}]},"sent_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Sent By Id"},"sent_to_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sent To Email"},"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"drive":{"$ref":"#/components/schemas/DriveDTO"},"drive_role":{"$ref":"#/components/schemas/DriveRole"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"workspace":{"$ref":"#/components/schemas/WorkspaceDTO"},"invite_type":{"$ref":"#/components/schemas/InviteType"},"invite_target":{"$ref":"#/components/schemas/InviteTarget"}},"type":"object","required":["id","sent_by","sent_by_id","sent_to_email","drive_id","drive","drive_role","workspace_id","workspace","invite_type","invite_target"],"title":"DriveInviteDTO"},"DriveDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend"],"title":"DriveDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"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"}}}}
```

## Accepts invitation

> This is a PUBLIC route where anyone can accept invites.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/invites/{invite_id}/join":{"post":{"tags":["workspaces"],"summary":"Accepts invitation","description":"This is a PUBLIC route where anyone can accept invites.","operationId":"join_invite_workspaces_invites__invite_id__join_post","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The invite id","description":"The id of the invitation to join"},"description":"The id of the invitation to join"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_join_invite_workspaces_invites__invite_id__join_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceInviteDTO"},{"$ref":"#/components/schemas/DriveInviteDTO"},{"type":"null"}],"title":"Response Join Invite Workspaces Invites  Invite Id  Join Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_join_invite_workspaces_invites__invite_id__join_post":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_join_invite_workspaces_invites__invite_id__join_post"},"WorkspaceInviteDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"sent_by":{"anyOf":[{"$ref":"#/components/schemas/UserDTOBase"},{"type":"null"}]},"sent_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Sent By Id"},"sent_to_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sent To Email"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"workspace":{"$ref":"#/components/schemas/WorkspaceDTO"},"workspace_role":{"$ref":"#/components/schemas/WorkspaceRole"},"invite_type":{"$ref":"#/components/schemas/InviteType"},"invite_target":{"$ref":"#/components/schemas/InviteTarget"}},"type":"object","required":["id","sent_by","sent_by_id","sent_to_email","workspace_id","workspace","workspace_role","invite_type","invite_target"],"title":"WorkspaceInviteDTO"},"UserDTOBase":{"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"}},"type":"object","required":["id","name","email","avatar_url","user_type"],"title":"UserDTOBase"},"UserType":{"type":"string","enum":["regular","group"],"title":"UserType"},"WorkspaceDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"member_inherited_role":{"$ref":"#/components/schemas/WorkspaceRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"type":{"$ref":"#/components/schemas/WorkspaceType"},"onboarding":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Onboarding"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"}},"type":"object","required":["id","name","description","domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","organization","client_metadata"],"title":"WorkspaceDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"WorkspaceType":{"type":"string","enum":["PERSONAL","TEAM"],"title":"WorkspaceType"},"WorkspaceSettings":{"properties":{"transcription_model":{"$ref":"#/components/schemas/TranscriptionModelType"},"default_drive_inheritance":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}]}},"type":"object","required":["transcription_model"],"title":"WorkspaceSettings"},"TranscriptionModelType":{"type":"string","enum":["BEST","NANO"],"title":"TranscriptionModelType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"OrganizationDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"url_subdomain":{"type":"string","title":"Url Subdomain"},"email_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Domain"},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partnership_type":{"anyOf":[{"$ref":"#/components/schemas/PartnershipType"},{"type":"null"}]},"discount_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Discount Amount"}},"type":"object","required":["id","name","url_subdomain","email_domain","client_metadata","partnership_type","discount_amount"],"title":"OrganizationDTO"},"PartnershipType":{"type":"string","enum":["BRANDING","DISCOUNT","CONTRACT"],"title":"PartnershipType"},"InviteType":{"type":"string","enum":["drive","workspace","item"],"title":"InviteType"},"InviteTarget":{"type":"string","enum":["user","anyone"],"title":"InviteTarget"},"DriveInviteDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"sent_by":{"anyOf":[{"$ref":"#/components/schemas/UserDTOBase"},{"type":"null"}]},"sent_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Sent By Id"},"sent_to_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sent To Email"},"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"drive":{"$ref":"#/components/schemas/DriveDTO"},"drive_role":{"$ref":"#/components/schemas/DriveRole"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"workspace":{"$ref":"#/components/schemas/WorkspaceDTO"},"invite_type":{"$ref":"#/components/schemas/InviteType"},"invite_target":{"$ref":"#/components/schemas/InviteTarget"}},"type":"object","required":["id","sent_by","sent_by_id","sent_to_email","drive_id","drive","drive_role","workspace_id","workspace","invite_type","invite_target"],"title":"DriveInviteDTO"},"DriveDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend"],"title":"DriveDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"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"}}}}
```

## PUT /workspaces/{workspace\_id}/users/{user\_id}

> Updates people's permissions on a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/users/{user_id}":{"put":{"tags":["workspaces"],"summary":"Updates people's permissions on a workspace","operationId":"update_workspace_permissions_workspaces__workspace_id__users__user_id__put","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user id to update"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_workspace_permissions_workspaces__workspace_id__users__user_id__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_update_workspace_permissions_workspaces__workspace_id__users__user_id__put":{"properties":{"role":{"$ref":"#/components/schemas/WorkspaceRole","title":"The role to update"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["role"],"title":"Body_update_workspace_permissions_workspaces__workspace_id__users__user_id__put"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10],"title":"WorkspaceRole"},"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"}}}}
```

## DELETE /workspaces/{workspace\_id}/users/{user\_id\_to\_remove}

> Removes a user from a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/users/{user_id_to_remove}":{"delete":{"tags":["workspaces"],"summary":"Removes a user from a workspace","operationId":"remove_user_from_workspace_route_workspaces__workspace_id__users__user_id_to_remove__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace id","description":"The id of the workspace we want to deactivate the user in"},"description":"The id of the workspace we want to deactivate the user in"},{"name":"user_id_to_remove","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user id","description":"The id for the user we want to deactivate"},"description":"The id for the user we want to deactivate"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_remove_user_from_workspace_route_workspaces__workspace_id__users__user_id_to_remove__delete"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Remove User From Workspace Route Workspaces  Workspace Id  Users  User Id To Remove  Delete"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_remove_user_from_workspace_route_workspaces__workspace_id__users__user_id_to_remove__delete":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_remove_user_from_workspace_route_workspaces__workspace_id__users__user_id_to_remove__delete"},"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"}}}}
```

## GET /workspaces/{workspace\_domain}/domain

> Gets a workspace for workspace domain

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_domain}/domain":{"get":{"tags":["workspaces"],"summary":"Gets a workspace for workspace domain","operationId":"get_workspace_id_from_domain_workspaces__workspace_domain__domain_get","parameters":[{"name":"workspace_domain","in":"path","required":true,"schema":{"type":"string","title":"The workspace id or domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Get Workspace Id From Domain Workspaces  Workspace Domain  Domain Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"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"}}}}
```

## GET /workspaces/{workspace\_domain}/drives/{drive\_identifier}/identifier

> Gets a drive\_id from an identifier

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_domain}/drives/{drive_identifier}/identifier":{"get":{"tags":["workspaces"],"summary":"Gets a drive_id from an identifier","operationId":"get_drive_id_from_identifier_workspaces__workspace_domain__drives__drive_identifier__identifier_get","parameters":[{"name":"drive_identifier","in":"path","required":true,"schema":{"type":"string","title":"The drive identifier"}},{"name":"workspace_domain","in":"path","required":true,"schema":{"type":"string","title":"The workspace id or domain"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Get Drive Id From Identifier Workspaces  Workspace Domain  Drives  Drive Identifier  Identifier Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"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"}}}}
```

## Get share data

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

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/shares/{share_id}":{"get":{"tags":["workspaces"],"summary":"Get share data","description":"Return the contents of the folder -> an array of AssetDTO","operationId":"get_items_from_share_id_workspaces_shares__share_id__get","parameters":[{"name":"path","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path under share","description":"The path under the share to get the data for"},"description":"The path under the share to get the data for"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_items_from_share_id_workspaces_shares__share_id__get"}}}},"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"}}}}}}}},"components":{"schemas":{"Body_get_items_from_share_id_workspaces_shares__share_id__get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_items_from_share_id_workspaces_shares__share_id__get"},"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}},"type":"object","title":"PublishDataDTO"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"},"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"}}}}
```

## GET /workspaces/authorize/drives/{drive\_id}/{action}

> Authorize drive usage

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/authorize/drives/{drive_id}/{action}":{"get":{"tags":["workspaces"],"summary":"Authorize drive usage","operationId":"cloud_authorize_drive_workspaces_authorize_drives__drive_id___action__get","parameters":[{"name":"action","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Action","title":"The action we want to authorize"}},{"name":"drive_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_cloud_authorize_drive_workspaces_authorize_drives__drive_id___action__get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriveDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"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"},"Body_cloud_authorize_drive_workspaces_authorize_drives__drive_id___action__get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_cloud_authorize_drive_workspaces_authorize_drives__drive_id___action__get"},"DriveDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon"},"settings":{"$ref":"#/components/schemas/DriveSettings"},"type":{"$ref":"#/components/schemas/DriveType"},"identifier":{"type":"string","title":"Identifier"},"icon_type":{"$ref":"#/components/schemas/DriveIconType"},"member_inherited_role":{"$ref":"#/components/schemas/DriveRole"},"invite_id":{"type":"string","format":"uuid","title":"Invite Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"byos":{"anyOf":[{"$ref":"#/components/schemas/DriveByosData"},{"type":"null"}]},"default_storage_backend":{"anyOf":[{"$ref":"#/components/schemas/DriveDefaultStorageBackend"},{"type":"null"}]}},"type":"object","required":["id","name","description","icon","settings","type","identifier","icon_type","member_inherited_role","invite_id","workspace_id","byos","default_storage_backend"],"title":"DriveDTO"},"DriveSettings":{"properties":{"max_storage_bytes":{"type":"integer","title":"Max Storage Bytes"},"mount_path_macos":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Macos"},"mount_path_linux":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Linux"},"mount_path_windows":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mount Path Windows"}},"type":"object","required":["max_storage_bytes"],"title":"DriveSettings"},"DriveType":{"type":"string","enum":["catalog","magic","vault"],"title":"DriveType"},"DriveIconType":{"type":"string","enum":["color","emoji","attachment"],"title":"DriveIconType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"DriveByosData":{"properties":{"bucket":{"type":"string","title":"Bucket"},"endpoint":{"type":"string","title":"Endpoint"}},"type":"object","required":["bucket","endpoint"],"title":"DriveByosData"},"DriveDefaultStorageBackend":{"properties":{"provider":{"type":"string","title":"Provider"},"bucket":{"type":"string","title":"Bucket"}},"type":"object","required":["provider","bucket"],"title":"DriveDefaultStorageBackend"},"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"}}}}
```

## PUT /workspaces/{workspace\_id}/settings

> Update workspace settings

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/settings":{"put":{"tags":["workspaces"],"summary":"Update workspace settings","operationId":"set_workspace_transcription_model_workspaces__workspace_id__settings_put","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_set_workspace_transcription_model_workspaces__workspace_id__settings_put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_set_workspace_transcription_model_workspaces__workspace_id__settings_put":{"properties":{"transcription_model":{"anyOf":[{"$ref":"#/components/schemas/TranscriptionModelType"},{"type":"null"}],"title":"The transcription model","description":"New model to set it to"},"default_drive_inheritance":{"anyOf":[{"$ref":"#/components/schemas/DriveRole"},{"type":"null"}],"title":"The default drive inheritance","description":"Default access level for workspace members in new drives"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_set_workspace_transcription_model_workspaces__workspace_id__settings_put"},"TranscriptionModelType":{"type":"string","enum":["BEST","NANO"],"title":"TranscriptionModelType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole"},"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"}}}}
```

## GET /workspaces/shade-fs-public-key

> Get the FS public key to sign files

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/shade-fs-public-key":{"get":{"tags":["workspaces"],"summary":"Get the FS public key to sign files","operationId":"get_shade_fs_public_key_workspaces_shade_fs_public_key_get","responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Not found"}}}}}}
```

## POST /workspaces/{workspace\_id}/transfer-ownership/{new\_owner\_user\_id}

> Transfer a workspace to a new owner

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/transfer-ownership/{new_owner_user_id}":{"post":{"tags":["workspaces"],"summary":"Transfer a workspace to a new owner","operationId":"transfer_workspace_ownership_route_workspaces__workspace_id__transfer_ownership__new_owner_user_id__post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"new_owner_user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The user to transfer workspace ownership to"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_transfer_workspace_ownership_route_workspaces__workspace_id__transfer_ownership__new_owner_user_id__post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Transfer Workspace Ownership Route Workspaces  Workspace Id  Transfer Ownership  New Owner User Id  Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_transfer_workspace_ownership_route_workspaces__workspace_id__transfer_ownership__new_owner_user_id__post":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_transfer_workspace_ownership_route_workspaces__workspace_id__transfer_ownership__new_owner_user_id__post"},"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"}}}}
```

## POST /workspaces/{workspace\_id}/leave

> Leave a workspace

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/leave":{"post":{"tags":["workspaces"],"summary":"Leave a workspace","operationId":"leave_workspace_route_workspaces__workspace_id__leave_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_leave_workspace_route_workspaces__workspace_id__leave_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Leave Workspace Route Workspaces  Workspace Id  Leave Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_leave_workspace_route_workspaces__workspace_id__leave_post":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_leave_workspace_route_workspaces__workspace_id__leave_post"},"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"}}}}
```

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

> Invite a user to a public share

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/public-file-shares/{share_id}/email":{"post":{"tags":["workspaces"],"summary":"Invite a user to a public share","operationId":"invite_user_to_public_file_share_workspaces_public_file_shares__share_id__email_post","parameters":[{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_invite_user_to_public_file_share_workspaces_public_file_shares__share_id__email_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_invite_user_to_public_file_share_workspaces_public_file_shares__share_id__email_post":{"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"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["email","message","link"],"title":"Body_invite_user_to_public_file_share_workspaces_public_file_shares__share_id__email_post"},"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"}}}}
```

## Get Svix webhook dashboard URL for workspace

> Generate and return a Svix dashboard URL for the workspace webhooks.\
> User must be an admin, member, or owner of the workspace.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/webhook-dashboard-url":{"get":{"tags":["workspaces"],"summary":"Get Svix webhook dashboard URL for workspace","description":"Generate and return a Svix dashboard URL for the workspace webhooks.\nUser must be an admin, member, or owner of the workspace.","operationId":"get_webhook_dashboard_url_workspaces__workspace_id__webhook_dashboard_url_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_webhook_dashboard_url_workspaces__workspace_id__webhook_dashboard_url_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Webhook Dashboard Url Workspaces  Workspace Id  Webhook Dashboard Url Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_webhook_dashboard_url_workspaces__workspace_id__webhook_dashboard_url_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_webhook_dashboard_url_workspaces__workspace_id__webhook_dashboard_url_get"},"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"}}}}
```

## Get Svix webhook zapier integration key for workspace

> Generate and return a Svix dashboard URL for the workspace webhooks.\
> User must be an admin, member, or owner of the workspace.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/workspaces/{workspace_id}/zapier-integration-key":{"get":{"tags":["workspaces"],"summary":"Get Svix webhook zapier integration key for workspace","description":"Generate and return a Svix dashboard URL for the workspace webhooks.\nUser must be an admin, member, or owner of the workspace.","operationId":"get_zapier_integration_key_workspaces__workspace_id__zapier_integration_key_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_zapier_integration_key_workspaces__workspace_id__zapier_integration_key_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Zapier Integration Key Workspaces  Workspace Id  Zapier Integration Key Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_zapier_integration_key_workspaces__workspace_id__zapier_integration_key_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_zapier_integration_key_workspaces__workspace_id__zapier_integration_key_get"},"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"}}}}
```