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

# Workspaces

A workspace is your team's account in Shade. It holds members, billing, and one or more drives.

**Start here:** `GET /workspaces` lists every workspace the API key's user belongs to, with each workspace's `id`. Pass that ID to `GET /workspaces/{workspace_id}/drives` to find your drives.

## GET /workspaces

> Lists all the workspaces for that user based on permissions

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"WorkspaceListDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"team_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team 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"},"onboarding_tasks":{"anyOf":[{"additionalProperties":{"type":"boolean"},"type":"object"},{"type":"null"}],"title":"Onboarding Tasks"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"store_analytics":{"type":"boolean","title":"Store Analytics"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id"},"created":{"type":"string","format":"date-time","title":"Created"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"sales_settings":{"anyOf":[{"$ref":"#/components/schemas/SalesSettings"},{"type":"null"}]},"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","team_domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","store_analytics","organization","client_metadata","created","actions","personal","role"],"title":"WorkspaceListDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10,0],"title":"WorkspaceRole","description":"A user's role in a workspace. Higher values grant more access."},"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"}]},"status":{"$ref":"#/components/schemas/WorkspaceStatus","default":"ACTIVE"},"link_sharing_enabled":{"type":"boolean","title":"Link Sharing Enabled","default":true},"custom_links_enabled":{"type":"boolean","title":"Custom Links Enabled","default":true},"link_sharing_templates":{"items":{"$ref":"#/components/schemas/WorkspaceLinkSharingTemplate-Output"},"type":"array","title":"Link Sharing Templates"},"default_comments_internal":{"type":"boolean","title":"Default Comments Internal","default":false},"domain_discovery_enabled":{"type":"boolean","title":"Domain Discovery Enabled","default":false}},"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","description":"A user's role on a drive, folder, or file. Higher values grant more access."},"WorkspaceStatus":{"type":"string","enum":["ACTIVE","WARNED","LOCKED"],"title":"WorkspaceStatus"},"WorkspaceLinkSharingTemplate-Output":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","maxLength":255,"title":"Name"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Allowed Actions"},"icon":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Icon"},"icon_type":{"type":"string","title":"Icon Type","default":"color"},"settings":{"anyOf":[{"$ref":"#/components/schemas/LinkTemplateSettings-Output"},{"type":"null"}]},"locked":{"type":"boolean","title":"Locked","default":false}},"type":"object","required":["id","name","allowed_actions"],"title":"WorkspaceLinkSharingTemplate"},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"LinkTemplateSettings-Output":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"password_required":{"type":"boolean","title":"Password Required","default":false},"expiration_duration_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expiration Duration Days"},"max_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max View Count"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"LinkTemplateSettings"},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"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"},"SalesSettings":{"properties":{"account_manager":{"anyOf":[{"$ref":"#/components/schemas/AccountManager"},{"type":"null"}]},"customer_success_manager":{"anyOf":[{"$ref":"#/components/schemas/CustomerSuccessManager"},{"type":"null"}]}},"type":"object","title":"SalesSettings"},"AccountManager":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["name","email"],"title":"AccountManager"},"CustomerSuccessManager":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["name","email"],"title":"CustomerSuccessManager"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces":{"get":{"tags":["workspaces"],"summary":"Lists all the workspaces for that user based on permissions","operationId":"listWorkspaces","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceListDTO"}}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Creates a workspace

> Create a workspace.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"CreateWorkspaceRequest":{"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":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Size"},"team_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Domain"},"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 link to image"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain of workspace","description":"Custom domain for the workspae"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner ID","description":"Partner ID for the workspace (e.g. PartnerStack)"}},"type":"object","required":["name","description"],"title":"CreateWorkspaceRequest"},"WorkspaceDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"team_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team 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"},"onboarding_tasks":{"anyOf":[{"additionalProperties":{"type":"boolean"},"type":"object"},{"type":"null"}],"title":"Onboarding Tasks"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"store_analytics":{"type":"boolean","title":"Store Analytics"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id"},"created":{"type":"string","format":"date-time","title":"Created"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"sales_settings":{"anyOf":[{"$ref":"#/components/schemas/SalesSettings"},{"type":"null"}]}},"type":"object","required":["id","name","description","domain","team_domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","store_analytics","organization","client_metadata","created"],"title":"WorkspaceDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10,0],"title":"WorkspaceRole","description":"A user's role in a workspace. Higher values grant more access."},"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"}]},"status":{"$ref":"#/components/schemas/WorkspaceStatus","default":"ACTIVE"},"link_sharing_enabled":{"type":"boolean","title":"Link Sharing Enabled","default":true},"custom_links_enabled":{"type":"boolean","title":"Custom Links Enabled","default":true},"link_sharing_templates":{"items":{"$ref":"#/components/schemas/WorkspaceLinkSharingTemplate-Output"},"type":"array","title":"Link Sharing Templates"},"default_comments_internal":{"type":"boolean","title":"Default Comments Internal","default":false},"domain_discovery_enabled":{"type":"boolean","title":"Domain Discovery Enabled","default":false}},"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","description":"A user's role on a drive, folder, or file. Higher values grant more access."},"WorkspaceStatus":{"type":"string","enum":["ACTIVE","WARNED","LOCKED"],"title":"WorkspaceStatus"},"WorkspaceLinkSharingTemplate-Output":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","maxLength":255,"title":"Name"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Allowed Actions"},"icon":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Icon"},"icon_type":{"type":"string","title":"Icon Type","default":"color"},"settings":{"anyOf":[{"$ref":"#/components/schemas/LinkTemplateSettings-Output"},{"type":"null"}]},"locked":{"type":"boolean","title":"Locked","default":false}},"type":"object","required":["id","name","allowed_actions"],"title":"WorkspaceLinkSharingTemplate"},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"LinkTemplateSettings-Output":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"password_required":{"type":"boolean","title":"Password Required","default":false},"expiration_duration_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expiration Duration Days"},"max_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max View Count"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"LinkTemplateSettings"},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"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"},"SalesSettings":{"properties":{"account_manager":{"anyOf":[{"$ref":"#/components/schemas/AccountManager"},{"type":"null"}]},"customer_success_manager":{"anyOf":[{"$ref":"#/components/schemas/CustomerSuccessManager"},{"type":"null"}]}},"type":"object","title":"SalesSettings"},"AccountManager":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["name","email"],"title":"AccountManager"},"CustomerSuccessManager":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["name","email"],"title":"CustomerSuccessManager"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces":{"post":{"tags":["workspaces"],"summary":"Creates a workspace","description":"Create a workspace.","operationId":"createWorkspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceRequest"}}}},"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"}}}}}}}}}
```

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

> Gets the # of available credits on a workspace

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces{workspace_id}/credits":{"post":{"tags":["workspaces"],"summary":"Gets the # of available credits on a workspace","operationId":"getWorkspaceCredits","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Gets a workspace from the workspace\_id

> Gets a workspace from the workspace\_id

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"WorkspaceListDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"team_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team 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"},"onboarding_tasks":{"anyOf":[{"additionalProperties":{"type":"boolean"},"type":"object"},{"type":"null"}],"title":"Onboarding Tasks"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"store_analytics":{"type":"boolean","title":"Store Analytics"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id"},"created":{"type":"string","format":"date-time","title":"Created"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"sales_settings":{"anyOf":[{"$ref":"#/components/schemas/SalesSettings"},{"type":"null"}]},"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","team_domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","store_analytics","organization","client_metadata","created","actions","personal","role"],"title":"WorkspaceListDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10,0],"title":"WorkspaceRole","description":"A user's role in a workspace. Higher values grant more access."},"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"}]},"status":{"$ref":"#/components/schemas/WorkspaceStatus","default":"ACTIVE"},"link_sharing_enabled":{"type":"boolean","title":"Link Sharing Enabled","default":true},"custom_links_enabled":{"type":"boolean","title":"Custom Links Enabled","default":true},"link_sharing_templates":{"items":{"$ref":"#/components/schemas/WorkspaceLinkSharingTemplate-Output"},"type":"array","title":"Link Sharing Templates"},"default_comments_internal":{"type":"boolean","title":"Default Comments Internal","default":false},"domain_discovery_enabled":{"type":"boolean","title":"Domain Discovery Enabled","default":false}},"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","description":"A user's role on a drive, folder, or file. Higher values grant more access."},"WorkspaceStatus":{"type":"string","enum":["ACTIVE","WARNED","LOCKED"],"title":"WorkspaceStatus"},"WorkspaceLinkSharingTemplate-Output":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","maxLength":255,"title":"Name"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Allowed Actions"},"icon":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Icon"},"icon_type":{"type":"string","title":"Icon Type","default":"color"},"settings":{"anyOf":[{"$ref":"#/components/schemas/LinkTemplateSettings-Output"},{"type":"null"}]},"locked":{"type":"boolean","title":"Locked","default":false}},"type":"object","required":["id","name","allowed_actions"],"title":"WorkspaceLinkSharingTemplate"},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"LinkTemplateSettings-Output":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"password_required":{"type":"boolean","title":"Password Required","default":false},"expiration_duration_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expiration Duration Days"},"max_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max View Count"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"LinkTemplateSettings"},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"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"},"SalesSettings":{"properties":{"account_manager":{"anyOf":[{"$ref":"#/components/schemas/AccountManager"},{"type":"null"}]},"customer_success_manager":{"anyOf":[{"$ref":"#/components/schemas/CustomerSuccessManager"},{"type":"null"}]}},"type":"object","title":"SalesSettings"},"AccountManager":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["name","email"],"title":"AccountManager"},"CustomerSuccessManager":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["name","email"],"title":"CustomerSuccessManager"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}":{"get":{"tags":["workspaces"],"summary":"Gets a workspace from the workspace_id","description":"Gets a workspace from the workspace_id","operationId":"getWorkspace","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"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"}}}}}}}}}
```

## Updates a workspace

> Update a workspace.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UpdateWorkspaceRequest":{"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"},"onboarding_task_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onboarding Task Key","description":"Getting-started checklist key to set as finished"},"client_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Client metadata","description":"set client metadata"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner ID","description":"Partner ID for the workspace (e.g. PartnerStack). Pass empty string to clear."}},"type":"object","title":"UpdateWorkspaceRequest"},"WorkspaceDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"domain":{"type":"string","title":"Domain"},"team_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team 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"},"onboarding_tasks":{"anyOf":[{"additionalProperties":{"type":"boolean"},"type":"object"},{"type":"null"}],"title":"Onboarding Tasks"},"settings":{"$ref":"#/components/schemas/WorkspaceSettings"},"trial_started":{"type":"boolean","title":"Trial Started"},"store_analytics":{"type":"boolean","title":"Store Analytics"},"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationDTO"},{"type":"null"}]},"client_metadata":{"additionalProperties":true,"type":"object","title":"Client Metadata"},"partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Id"},"created":{"type":"string","format":"date-time","title":"Created"},"last_accessed":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Accessed"},"sales_settings":{"anyOf":[{"$ref":"#/components/schemas/SalesSettings"},{"type":"null"}]}},"type":"object","required":["id","name","description","domain","team_domain","thumbnail","member_inherited_role","invite_id","type","onboarding","settings","trial_started","store_analytics","organization","client_metadata","created"],"title":"WorkspaceDTO"},"WorkspaceRole":{"type":"integer","enum":[60,50,30,20,15,10,0],"title":"WorkspaceRole","description":"A user's role in a workspace. Higher values grant more access."},"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"}]},"status":{"$ref":"#/components/schemas/WorkspaceStatus","default":"ACTIVE"},"link_sharing_enabled":{"type":"boolean","title":"Link Sharing Enabled","default":true},"custom_links_enabled":{"type":"boolean","title":"Custom Links Enabled","default":true},"link_sharing_templates":{"items":{"$ref":"#/components/schemas/WorkspaceLinkSharingTemplate-Output"},"type":"array","title":"Link Sharing Templates"},"default_comments_internal":{"type":"boolean","title":"Default Comments Internal","default":false},"domain_discovery_enabled":{"type":"boolean","title":"Domain Discovery Enabled","default":false}},"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","description":"A user's role on a drive, folder, or file. Higher values grant more access."},"WorkspaceStatus":{"type":"string","enum":["ACTIVE","WARNED","LOCKED"],"title":"WorkspaceStatus"},"WorkspaceLinkSharingTemplate-Output":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","maxLength":255,"title":"Name"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Allowed Actions"},"icon":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Icon"},"icon_type":{"type":"string","title":"Icon Type","default":"color"},"settings":{"anyOf":[{"$ref":"#/components/schemas/LinkTemplateSettings-Output"},{"type":"null"}]},"locked":{"type":"boolean","title":"Locked","default":false}},"type":"object","required":["id","name","allowed_actions"],"title":"WorkspaceLinkSharingTemplate"},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"LinkTemplateSettings-Output":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"password_required":{"type":"boolean","title":"Password Required","default":false},"expiration_duration_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expiration Duration Days"},"max_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max View Count"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"LinkTemplateSettings"},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"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"},"SalesSettings":{"properties":{"account_manager":{"anyOf":[{"$ref":"#/components/schemas/AccountManager"},{"type":"null"}]},"customer_success_manager":{"anyOf":[{"$ref":"#/components/schemas/CustomerSuccessManager"},{"type":"null"}]}},"type":"object","title":"SalesSettings"},"AccountManager":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["name","email"],"title":"AccountManager"},"CustomerSuccessManager":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["name","email"],"title":"CustomerSuccessManager"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}":{"put":{"tags":["workspaces"],"summary":"Updates a workspace","description":"Update a workspace.","operationId":"updateWorkspace","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceRequest"}}}},"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"}}}}}}}}}
```

## DELETE /workspaces/{workspace\_id}

> Deletes a workspace

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}":{"delete":{"tags":["workspaces"],"summary":"Deletes a workspace","operationId":"deleteWorkspace","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /workspaces/avatar/upload-url

> Create an avatar for a workspace

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"WorkspaceCreateAvatarUploadUrlRequest":{"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":"WorkspaceCreateAvatarUploadUrlRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/avatar/upload-url":{"post":{"tags":["workspaces"],"summary":"Create an avatar for a workspace","operationId":"workspaceCreateAvatarUploadUrl","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCreateAvatarUploadUrlRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

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

> Confirm uploading an avatar for a workspace

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"WorkspaceCompleteAvatarRequest":{"properties":{"download_url":{"title":"Download url","description":"The download url"}},"type":"object","required":["download_url"],"title":"WorkspaceCompleteAvatarRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}/avatar/complete":{"post":{"tags":["workspaces"],"summary":"Confirm uploading an avatar for a workspace","operationId":"workspaceCompleteAvatar","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCompleteAvatarRequest"}}}},"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"}}}}}}}}}
```

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

> Gets a workspace for workspace domain

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_domain}/domain":{"get":{"tags":["workspaces"],"summary":"Gets a workspace for workspace domain","operationId":"getWorkspaceIdFromDomain","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"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

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

> Update workspace settings

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"workspaces","description":"A workspace is your team's account in Shade. It holds members, billing, and\none or more drives.\n\n**Start here:** `GET /workspaces` lists every workspace the API key's user\nbelongs to, with each workspace's `id`. Pass that ID to\n`GET /workspaces/{workspace_id}/drives` to find your drives."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UpdateWorkspaceSettingsRequest":{"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"},"link_sharing_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether link sharing is enabled for this workspace","description":"When disabled, all public link sharing is turned off."},"custom_links_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether custom public links are enabled for this workspace","description":"When disabled, users can only create public links from workspace templates."},"link_sharing_templates":{"anyOf":[{"items":{"$ref":"#/components/schemas/WorkspaceLinkSharingTemplate-Input"},"type":"array"},{"type":"null"}],"title":"Workspace-level link sharing templates","description":"Templates used in the sharing modal quick links."},"default_comments_internal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default comments to internal","description":"When enabled, new comments from workspace members default to internal visibility."},"domain_discovery_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether this workspace is discoverable by email domain","description":"When enabled, users with a matching company email domain can find and join this workspace during onboarding."}},"type":"object","title":"UpdateWorkspaceSettingsRequest"},"TranscriptionModelType":{"type":"string","enum":["BEST","NANO"],"title":"TranscriptionModelType"},"DriveRole":{"type":"integer","enum":[50,40,30,20,17,15,10,0],"title":"DriveRole","description":"A user's role on a drive, folder, or file. Higher values grant more access."},"WorkspaceLinkSharingTemplate-Input":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","maxLength":255,"title":"Name"},"allowed_actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","title":"Allowed Actions"},"icon":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Icon"},"icon_type":{"type":"string","title":"Icon Type","default":"color"},"settings":{"anyOf":[{"$ref":"#/components/schemas/LinkTemplateSettings-Input"},{"type":"null"}]},"locked":{"type":"boolean","title":"Locked","default":false}},"type":"object","required":["id","name","allowed_actions"],"title":"WorkspaceLinkSharingTemplate"},"Action":{"type":"string","enum":["manage","edit","share","comment","edit_metadata","download","read","read_asset_details","read_metadata","manage_webhooks","manage_drive","view_stack_versions"],"title":"Action","description":"An action a user or share link is allowed to take."},"LinkTemplateSettings-Input":{"properties":{"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"password_required":{"type":"boolean","title":"Password Required","default":false},"expiration_duration_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expiration Duration Days"},"max_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max View Count"},"watermarking_config":{"anyOf":[{"$ref":"#/components/schemas/WatermarkingConfiguration"},{"type":"null"}]}},"type":"object","title":"LinkTemplateSettings"},"WatermarkingConfiguration":{"properties":{"mode":{"$ref":"#/components/schemas/WatermarkingMode"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"position":{"anyOf":[{"$ref":"#/components/schemas/WatermarkPosition"},{"type":"null"}]},"font_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Font Size"}},"type":"object","required":["mode"],"title":"WatermarkingConfiguration","description":"Typed configuration for text-based watermarking and transcoder options."},"WatermarkingMode":{"type":"string","enum":["session","text"],"title":"WatermarkingMode"},"WatermarkPosition":{"type":"string","enum":["top_left","top_center","top_right","center","bottom_left","bottom_center","bottom_right"],"title":"WatermarkPosition"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}/settings":{"put":{"tags":["workspaces"],"summary":"Update workspace settings","operationId":"updateWorkspaceSettings","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceSettingsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"null"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

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

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

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

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

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

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

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