# Shade Academy ## Shade Academy - [Welcome](https://academy.shade.inc/readme.md) - [What is Shade](https://academy.shade.inc/getting-started/what-is-shade.md) - [Get the App](https://academy.shade.inc/getting-started/quickstart.md) - [Understand the Structure](https://academy.shade.inc/getting-started/publish-your-docs.md) - [Learn 80% of Shade in 2 minutes](https://academy.shade.inc/getting-started/learn-80-of-shade-in-2-minutes.md) - [Start Uploading Assets](https://academy.shade.inc/getting-started/start-uploading-assets.md) - [The Shade Method](https://academy.shade.inc/getting-started/the-shade-method.md) - [Setting Up Workspaces and Drives](https://academy.shade.inc/workspaces-and-drives/setting-up-workspaces-and-drives.md) - [Workspace Settings](https://academy.shade.inc/workspaces-and-drives/workspace-settings.md) - [Account Settings & Preferences](https://academy.shade.inc/workspaces-and-drives/account-settings-and-preferences.md) - [Drive Templates](https://academy.shade.inc/workspaces-and-drives/drive-templates.md) - [Drive Status Menu](https://academy.shade.inc/workspaces-and-drives/drive-status-menu.md) - [Drive Settings](https://academy.shade.inc/workspaces-and-drives/drive-settings.md) - [Folder Templates](https://academy.shade.inc/workspaces-and-drives/folder-templates.md) - [Managing your Trash](https://academy.shade.inc/workspaces-and-drives/managing-your-trash.md) - [Zapier Integration](https://academy.shade.inc/workspaces-and-drives/zapier-integration.md) - [Guests vs Workspace Members](https://academy.shade.inc/sharing-and-collaboration/guests-vs-workspace-members.md): What's the difference between a guest and a workspace, and when to use - [Permission Management Overview](https://academy.shade.inc/sharing-and-collaboration/permission-management-overview.md) - [Workspace and Drive Permissions](https://academy.shade.inc/sharing-and-collaboration/workspace-and-drive-permissions.md) - [Permissions Table](https://academy.shade.inc/sharing-and-collaboration/permissions-table.md) - [Designing Your Permission Hierarchy](https://academy.shade.inc/sharing-and-collaboration/designing-your-permission-hierarchy.md) - [Permission Inheritance Examples](https://academy.shade.inc/sharing-and-collaboration/permission-inheritance-examples.md) - [Inviting External Collaborators](https://academy.shade.inc/sharing-and-collaboration/inviting-external-collaborators.md) - [Published Links](https://academy.shade.inc/sharing-and-collaboration/published-links.md) - [Sharing Folders and Files](https://academy.shade.inc/sharing-and-collaboration/sharing-folders-and-files.md) - [Creating Asset Collections](https://academy.shade.inc/sharing-and-collaboration/creating-asset-collections.md): How to create, manage, and share collection with Shade. - [Commenting on Assets](https://academy.shade.inc/sharing-and-collaboration/commenting-on-assets.md): A comprehensive guide to Shade's commenting system, detailing how to leave time-stamped, anchored, and threaded comments to streamline collaboration and feedback for creative teams. - [Working with Clients: Best Practices](https://academy.shade.inc/sharing-and-collaboration/working-with-clients-best-practices.md) - [Introduction to ShadeFS](https://academy.shade.inc/shadefs/introduction-to-shadefs.md) - [Managing the ShadeFS Cache](https://academy.shade.inc/shadefs/managing-the-shadefs-cache.md) - [Pinning Files Offline](https://academy.shade.inc/shadefs/pinning-files-offline.md) - [Choosing an External SSD for Shade Cache](https://academy.shade.inc/shadefs/choosing-an-external-ssd-for-shade-cache.md): Choosing an external SSD can help improve your performance with Shade - [Understanding Internet Speeds and ShadeFS Storage](https://academy.shade.inc/shadefs/understanding-internet-speeds-and-shadefs-storage.md): How internet speed relates to your media bitrate - [ShadeFS Troubleshooting Guide](https://academy.shade.inc/shadefs/shadefs-troubleshooting-guide.md) - [Default Shortcuts](https://academy.shade.inc/assets/default-shortcuts.md) - [Precision Filtering](https://academy.shade.inc/assets/precision-filtering.md) - [Proxy Generation and Complex Previews](https://academy.shade.inc/assets/markdown.md) - [Asset Card Display](https://academy.shade.inc/assets/asset-card-display.md) - [Copying & Moving Content](https://academy.shade.inc/assets/copying-content-between-drives.md) - [Search and Discovery (Transcription & Precision Filtering)](https://academy.shade.inc/assets/search-and-discovery-transcription-and-precision-filtering.md) - [Version Control and Stacking](https://academy.shade.inc/assets/version-control-and-stacking.md) - [Snapshots](https://academy.shade.inc/assets/snapshots.md) - [Duplicate Detection](https://academy.shade.inc/assets/duplicate-detection.md) - [The Shade MCP](https://academy.shade.inc/ai-tools/the-shade-mcp.md) - [AI Search Best Practices](https://academy.shade.inc/ai-tools/ai-search-best-practices.md) - [Metadata and Custom Fields](https://academy.shade.inc/ai-tools/custom-and-automated-metadata.md) - [Facial Recognition](https://academy.shade.inc/ai-tools/facial-recognition.md) - [Exporting Metadata into Your NLE](https://academy.shade.inc/ai-tools/exporting-metadata-into-your-nle.md): How to easily export any view into your NLE - [Automations](https://academy.shade.inc/automations-and-custom-objects/automations.md) - [Custom Objects](https://academy.shade.inc/automations-and-custom-objects/custom-objects.md) - [Bring Your Own S3 Storage](https://academy.shade.inc/byos/bring-your-own-s3-storage.md): Shade allows you to connect a self-hosted S3 bucket as your storage backend for Shade. - [Connecting Shade to Backblaze](https://academy.shade.inc/byos/connecting-shade-to-backblaze.md) - [Connecting Shade to Wasabi](https://academy.shade.inc/byos/connecting-shade-to-wasabi.md) - [Connecting Shade with Google Cloud Storage](https://academy.shade.inc/byos/connecting-shade-with-google-cloud-storage.md) - [Connecting Shade with AWS S3](https://academy.shade.inc/byos/connecting-shade-with-aws-s3.md) - [Billing](https://academy.shade.inc/administration-and-security/billing.md) - [How your Data is Stored and Protected](https://academy.shade.inc/administration-and-security/how-your-data-is-stored-and-protected.md) - [Using Shared Cache](https://academy.shade.inc/shared-cache/using-shared-cache.md) - [Enterprise Security and SSO](https://academy.shade.inc/enterprise/enterprise-security-and-sso.md) - [Deploying the Shade PKG to Jamf Pro](https://academy.shade.inc/enterprise/deploying-the-shade-pkg-to-jamf-pro.md): This guide walks through downloading the Shade installer package (PKG) and uploading it into Jamf Pro so it can be deployed to Macs. - [Tips & Tricks](https://academy.shade.inc/skip-the-reading.-start-watching/tips-and-tricks.md) ## Guides - [Guides](https://academy.shade.inc/guides/guides.md): Step-by-step guides for getting real work done in Shade, from setting up your first drive to automating client delivery. - [Setup and migration](https://academy.shade.inc/guides/setup-and-migration.md): Set up drives and permissions that fit how your team works, and bring your existing media into Shade. - [Your first week in Shade](https://academy.shade.inc/guides/setup-and-migration/your-first-week-in-shade.md): Set up drives, templates, and permissions for a small team in the order that saves you rework later. - [Set up an agency workspace](https://academy.shade.inc/guides/setup-and-migration/set-up-an-agency-workspace.md): One drive per client, a reusable template drive, and guest access that keeps clients out of each other's work. - [Migrate from Dropbox or Google Drive](https://academy.shade.inc/guides/setup-and-migration/migrate-from-dropbox-or-google-drive.md): Move folders from Dropbox or Google Drive into Shade with built-in transfers, then check that everything arrived. - [Mass migrating Data to Shade via Rclone](https://academy.shade.inc/guides/setup-and-migration/mass-migrating-data-to-shade-via-rclone.md): How to migrate data into Shade via Rclone - [Roll out Shade company-wide](https://academy.shade.inc/guides/setup-and-migration/roll-out-shade-company-wide.md): An admin's checklist for rolling Shade out to a large organization, with SSO, SCIM, managed installs, and shared cache. - [Editing integrations](https://academy.shade.inc/guides/editing-integrations.md): Edit straight from Shade in your editing app, at home, on set, or offline. - [How to use Shade with Adobe Premiere Pro](https://academy.shade.inc/guides/editing-integrations/how-to-use-shade-with-adobe-premiere-pro.md): Follow this video and guide to properly set up Adobe Premiere Pro for Shade - [How to use Shade with Davinci Resolve Projects](https://academy.shade.inc/guides/editing-integrations/how-to-use-shade-with-davinci-resolve-projects.md): Follow this video and guide to properly set up Davinci Resolve for Shade. - [How to use Shade with AVID Media Composer](https://academy.shade.inc/guides/editing-integrations/how-to-use-shade-with-avid-media-composer.md) - [How to use Shade with Final Cut Pro](https://academy.shade.inc/guides/editing-integrations/how-to-use-shade-with-final-cut-pro.md) - [Edit remotely over ShadeFS](https://academy.shade.inc/guides/editing-integrations/edit-remotely-over-shadefs.md): Size your cache, pin footage for offline work, and choose the right media for your connection, so remote editing feels local. - [Send Shade metadata into your editing app](https://academy.shade.inc/guides/editing-integrations/send-shade-metadata-into-your-editing-app.md): Bring tags, descriptions, statuses, and selects from Shade into Premiere Pro, Resolve, or Avid bins. - [Automations](https://academy.shade.inc/guides/automations.md): Recipes for automations that organize, share, and publish files for you when something happens in a drive. - [Your first automation](https://academy.shade.inc/guides/automations/your-first-automation.md): Send every new upload into a "To review" collection automatically. Ten minutes, no code. - [Auto-organize new uploads](https://academy.shade.inc/guides/automations/auto-organize-new-uploads.md): Set metadata, rename, and file new uploads into the right project folder the moment they land. - [Tell a client their files are ready](https://academy.shade.inc/guides/automations/tell-a-client-their-files-are-ready.md): Right-click a folder, type the client's email, and Shade creates a share link and sends it for you. - [Publish to YouTube or Vimeo after approval](https://academy.shade.inc/guides/automations/publish-to-youtube-or-vimeo-after-approval.md): When a cut's status changes to Approved, Shade uploads it to your YouTube channel or Vimeo account. - [Turn long videos into social clips with Opus Clip](https://academy.shade.inc/guides/automations/turn-long-videos-into-social-clips-with-opus-clip.md): Send long-form video to Opus Clip automatically, and save the short clips it generates back into your drive. - [Batch-enhance photos with Topaz](https://academy.shade.inc/guides/automations/batch-enhance-photos-with-topaz.md): Upscale, denoise, sharpen, or deblur every photo dropped into a folder with Topaz Labs, and save the results next to the originals. - [Connect Shade to other tools with webhooks](https://academy.shade.inc/guides/automations/connect-shade-to-other-tools-with-webhooks.md): Start Shade automations from any tool with a webhook, and send data from Shade to any API with an HTTP request. - [Get alerted when a person appears in footage](https://academy.shade.inc/guides/automations/get-alerted-when-a-person-appears-in-footage.md): Get an email whenever Shade recognizes a specific person in new photos or video. - [Custom objects and metadata](https://academy.shade.inc/guides/custom-objects-and-metadata.md): Model the clients, projects, and deliverables behind your media, and design metadata that stays consistent across drives. - [Model projects and clients as custom objects](https://academy.shade.inc/guides/custom-objects-and-metadata/model-projects-and-clients-as-custom-objects.md): Track clients and projects inside Shade, link every asset to the work it belongs to, and see a client's media in one view. - [Create a folder for every new project](https://academy.shade.inc/guides/custom-objects-and-metadata/create-a-folder-for-every-new-project.md): Adding a project record builds the project's folder structure from a template automatically. - [Design a metadata schema that scales](https://academy.shade.inc/guides/custom-objects-and-metadata/design-a-metadata-schema-that-scales.md): Choose field types, options, AI prompts, and naming rules that stay consistent as you add drives and people. - [Review and client delivery](https://academy.shade.inc/guides/review-and-client-delivery.md): Run review cycles, deliver final files, and work safely with clients and freelancers. - [The client review loop](https://academy.shade.inc/guides/review-and-client-delivery/the-client-review-loop.md): Share a cut, collect frame-accurate feedback, upload the next version, and get sign-off without leaving Shade. - [Deliver final files to a client](https://academy.shade.inc/guides/review-and-client-delivery/deliver-final-files-to-a-client.md): Deliver finals with a branded collection, the right download permissions, and links that expire. - [Work with freelancers](https://academy.shade.inc/guides/review-and-client-delivery/work-with-freelancers.md): Give freelancers exactly the access a job needs, let them mount drives when they need to, and remove access cleanly when the job ends. - [Search, AI, and archives](https://academy.shade.inc/guides/search-ai-and-archives.md): Turn years of footage into a library you can search by what's in it, and keep it tidy. - [Build a searchable archive](https://academy.shade.inc/guides/search-ai-and-archives/build-a-searchable-archive.md): Combine transcripts, AI search, face recognition, filters, and saved views so anyone can find any shot in seconds. - [Use the Shade MCP with Claude or Cursor](https://academy.shade.inc/guides/search-ai-and-archives/use-the-shade-mcp-with-claude-or-cursor.md): Connect your workspace to Claude, ChatGPT, or Cursor, and search, organize, and automate Shade from a prompt. - [Clean up storage](https://academy.shade.inc/guides/search-ai-and-archives/clean-up-storage.md): Find and remove duplicate files, empty the trash safely, and keep storage under control. - [Developers](https://academy.shade.inc/guides/developers.md): Build on Shade with the API, Python SDK, webhooks, and S3-compatible access. ## Developers - [Developer documentation](https://academy.shade.inc/developers/readme.md): Build on Shade with the REST API, S3 API, webhooks, and MCP server. - [Integrating with Shade](https://academy.shade.inc/developers/get-started/integrating-with-shade.md): Pick the right Shade interface for your integration, authenticate, and build a complete upload-to-metadata workflow. - [Uploading to Shade](https://academy.shade.inc/developers/guides/uploading-to-shade.md): Choose the right way to get files into Shade from scripts, servers, pipelines, and your own apps, and know what happens after the upload. - [Using the Shade MCP server](https://academy.shade.inc/developers/guides/using-the-shade-mcp-server.md): Connect AI agents and MCP clients to a Shade workspace: endpoint, OAuth, client configuration, available tools, and building your own agent. - [Syncing & reacting to file changes](https://academy.shade.inc/developers/guides/synchronizing-file-state.md) - [Webhooks](https://academy.shade.inc/developers/guides/webhooks.md): Enable webhooks to listen to changes in Shade - [Using Shade's S3 API](https://academy.shade.inc/developers/guides/using-shades-s3-api.md): Use Shade Drives as an S3 Bucket - [Writing your own uploader](https://academy.shade.inc/developers/guides/writing-your-own-uploader.md): If you're writing an app on top of Shade, this is how you upload files. - [Intro](https://academy.shade.inc/developers/using-the-api/using-the-api.md) - [Working with assets](https://academy.shade.inc/developers/using-the-api/working-with-assets.md): Look up assets by path or ID, download originals and proxies, organize files and folders, and read transcripts and comments through the Shade API. - [Searching and filtering assets](https://academy.shade.inc/developers/using-the-api/searching-and-filtering-assets.md): Find and list assets with POST /search: AI search, filters on paths, types, dates, and metadata, sorting, and paging through results. - [Metadata Guide](https://academy.shade.inc/developers/using-the-api/metadata-guide.md): A beginner's guide to creating and managing metadata attributes and options using the Shade API. - [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links.md): Group assets into collections and share files, folders, and collections with people outside your workspace using share links. - [Authentication](https://academy.shade.inc/developers/authentication.md) - [IDs and paths](https://academy.shade.inc/developers/ids-and-paths.md) - [Errors](https://academy.shade.inc/developers/errors.md) - [Uploading files](https://academy.shade.inc/developers/uploading-files.md) - [Workspaces](https://academy.shade.inc/developers/workspaces-and-drives/workspaces.md) - [Drives](https://academy.shade.inc/developers/workspaces-and-drives/drives.md) - [Members & permissions](https://academy.shade.inc/developers/workspaces-and-drives/members-and-permissions.md) - [Share links](https://academy.shade.inc/developers/workspaces-and-drives/share-links.md) - [Files & folders](https://academy.shade.inc/developers/files-and-assets/files-and-folders.md) - [Assets](https://academy.shade.inc/developers/files-and-assets/assets.md) - [Transcripts](https://academy.shade.inc/developers/files-and-assets/transcripts.md) - [Comments](https://academy.shade.inc/developers/files-and-assets/comments.md) - [Metadata](https://academy.shade.inc/developers/organize/metadata.md) - [Custom objects](https://academy.shade.inc/developers/organize/custom-objects.md) - [Collections](https://academy.shade.inc/developers/organize/collections.md) - [Views](https://academy.shade.inc/developers/organize/views.md) - [Folder templates](https://academy.shade.inc/developers/organize/folder-templates.md) - [Search](https://academy.shade.inc/developers/search-and-ai/search.md) - [People & faces](https://academy.shade.inc/developers/search-and-ai/people-and-faces.md) - [Automations](https://academy.shade.inc/developers/automate/automations.md) - [Webhooks](https://academy.shade.inc/developers/automate/webhooks.md) - [User](https://academy.shade.inc/developers/account-and-keys/user.md) - [API & S3 keys](https://academy.shade.inc/developers/account-and-keys/api-and-s3-keys.md) ## Help Center - [Help Center](https://academy.shade.inc/help-center/help-center.md): Answers to common questions about workspaces, drives, ShadeFS, billing, and security. - [When to use Shade Cloud](https://academy.shade.inc/help-center/general-faq/when-to-use-shade-cloud.md) - [How does Shade compare to other cloud NAS systems?](https://academy.shade.inc/help-center/general-faq/shade-compared-to-other-cloud-nas-systems.md) - [Our storage and subprocessors](https://academy.shade.inc/help-center/general-faq/our-storage-and-subprocessors.md): See our subprocessors and storage providers - [Does Shade offer a trial?](https://academy.shade.inc/help-center/general-faq/does-shade-offer-a-trial.md): Shade offers a 7-day no CC trial when you sign up - [How long does indexing take?](https://academy.shade.inc/help-center/general-faq/how-long-should-it-take-to-index-assets.md): Our indexing is designed to handle millions of assets - [My files failed to index](https://academy.shade.inc/help-center/general-faq/my-files-failed-to-index.md): This typically shouldn't happen, but if it does, just message us - [How good does my wifi have to be?](https://academy.shade.inc/help-center/general-faq/how-good-does-my-wifi-have-to-be.md): A guide explaining that Shade works well on standard internet connections. - [What are workspaces?](https://academy.shade.inc/help-center/workspaces-faq/what-are-workspaces.md) - [Creating a workspace](https://academy.shade.inc/help-center/workspaces-faq/creating-a-workspace.md) - [Deleting a workspace](https://academy.shade.inc/help-center/workspaces-faq/deleting-workspace.md): What happens to your drives, files, plan, and account when you delete a workspace. - [What's the difference between a workspace and a drive?](https://academy.shade.inc/help-center/workspaces-faq/difference-between-a-workspace-and-a-drive.md) - [What is drive inheritance?](https://academy.shade.inc/help-center/drive-faq/what-is-drive-inheritance.md) - [How does ShadeFS work in real time?](https://academy.shade.inc/help-center/drive-faq/how-shadefs-works-real-time.md) - [File and folder permissions](https://academy.shade.inc/help-center/drive-faq/file-folder-permissions.md) - [How ShadeFS outperforms traditional cloud storage](https://academy.shade.inc/help-center/shadefs-faq/how-shadefs-outperforms-traditional-cloud-storage.md): Why use ShadeFS over a Dropbox or Google Drive? - [How does ShadeFS compare to a NAS?](https://academy.shade.inc/help-center/shadefs-faq/how-does-shadefs-compare-to-a-nas.md): NAS's are traditionally expensive upfront, require maintenance and upkeep, and have poor remote experiences. - [WinFsp shows an "already installed" error](https://academy.shade.inc/help-center/shadefs-faq/winfsp-is-showing-an-already-installed-error.md) - [How do seat limits work?](https://academy.shade.inc/help-center/billing/how-do-seat-limits-work.md) - [Can I get a refund?](https://academy.shade.inc/help-center/billing/can-i-get-a-refund.md): What is Shade's refund policy? - [How do I add more seats and guests than my plan includes?](https://academy.shade.inc/help-center/billing/how-to-add-more-seats-and-guests-outside-of-my-plan.md) - [Do you offer migration assistance from existing storage?](https://academy.shade.inc/help-center/billing/do-you-offer-migration-assistance-from-existing-storage.md) - [Network configuration guide](https://academy.shade.inc/help-center/security/shade-network-configuration-guide.md) - [Shade is blocked by my internet provider](https://academy.shade.inc/help-center/security/shade-is-blocked-by-my-internet-provider.md) - [SIEM integration](https://academy.shade.inc/help-center/security/shade-siem-documentation.md): Integrating Shade with external security providers for comprehensive documentation and auditing - [Audit logging](https://academy.shade.inc/help-center/security/audit-logging.md): Keep track of events occurring in your workspace for real-time management and monitoring. - [Do you use our data for training your AI?](https://academy.shade.inc/help-center/ai-faq/do-you-use-our-data-for-training-your-ai.md) --- # 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 This site has an agentic ask interface you may use to query the documentation dynamically 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/index.md?ask=&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.