Shade is built from the ground up with proprietary AI that understands your files and assets for what they are, not what they’re named. But we only do this on the assets that you want us to index.
As a result, if you want to leverage Shade’s global search capabilities or upgraded neural file search, then you want to index your assets.So how do I do that? Well it’s really straightforward.Simply go to the folder that you want to search in the future, right click, and hit “index”.Shade supports everything from images to videos to 3D assets. Want to take a look at our file support? Check out our file support page.And all you need to do is index the folder that you want to search in the future.Take a look at the rest of our articles to learn more about indexing and specific particulars with various assets.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Shade","colors":{"primary":"#855CF8","light":"#855CF8","dark":"#855CF8"},"favicon":"/favicon.png","logo":{"dark":"https://mintlify.s3-us-west-1.amazonaws.com/shade/logo/dark.png","light":"https://mintlify.s3-us-west-1.amazonaws.com/shade/logo/light.png"},"background":{"decoration":null,"color":{"light":"#FFFFFF","dark":"#000000"}},"navbar":{"primary":{"type":"button","label":"Website","href":"https://shade.inc"}},"footer":{"socials":{"twitter":"https://twitter.com/TryShadeInc","github":"https://github.com/open-shade","linkedin":"https://www.linkedin.com/company/shadeinc","website":"https://shade.inc","discord":"https://discord.gg/h8wqFMJ4vK"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"shade","hasAudioNarration":false,"actualSubdomain":"shade","customDomains":["docs.shade.inc"],"gitSource":{"type":"github","owner":"open-shade","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9145e572e4ca5d52f97e1:success","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"Assets","count":20},{"language":"default","tag":"Indexing","count":14},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Collections","count":11},{"language":"default","tag":"Endpoint Examples","count":8},{"language":"default","tag":"Indexing Assets","count":5},{"language":"default","tag":"Studio","count":4},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Platform Guides","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"indexing-assets/indexing","slug":"/indexing-assets/indexing","pageMetadata":{"title":"Indexing Your Files with Shade","description":"How to index your files with Shade","href":"/indexing-assets/indexing"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"How to index your files with Shade\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`why-should-i-index-my-files`,children:`Why should I index my files?`}),`\n`,_jsx(_components.p,{children:`Shade is built from the ground up with proprietary AI that understands your files and assets for what they are, not what they’re named. But we only do this on the assets that you want us to index.\nAs a result, if you want to leverage Shade’s global search capabilities or upgraded neural file search, then you want to index your assets.`}),`\n`,_jsx(_components.p,{children:`So how do I do that? Well it’s really straightforward.`}),`\n`,_jsx(_components.p,{children:`Simply go to the folder that you want to search in the future, right click, and hit “index”.`}),`\n`,_jsx(`video`,{src:`https://firebasestorage.googleapis.com/v0/b/shade-prod.appspot.com/o/docs-videos%2Findex-external.mp4?alt=media\u0026token=c451fe8e-b937-4e13-b82d-c24cc244b3cd`,controls:true,autoPlay:true,playsInline:`true`,loop:`true`,muted:`true`}),`\n`,_jsxs(_components.p,{children:[`Shade supports everything from images to videos to 3D assets. Want to take a look at our file support? Check out our `,_jsx(_components.a,{href:`https://www.shade.inc/file-support`,children:`file support page`}),`.`]}),`\n`,_jsx(_components.p,{children:`And all you need to do is index the folder that you want to search in the future.`}),`\n`,_jsx(_components.p,{children:`Take a look at the rest of our articles to learn more about indexing and specific particulars with various assets.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Indexing Your Files with Shade","description":"How to index your files with Shade","href":"/indexing-assets/indexing"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Why should I index my files?","slug":"why-should-i-index-my-files","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"shade","siteName":"Shade","title":"Indexing Your Files with Shade - Shade","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"indexing-assets/indexing.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"How to index your files with Shade\">\u003cmeta data-mint-head name=\"application-name\" content=\"Shade\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/shade/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/shade/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/shade/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/shade/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Indexing Your Files with Shade - Shade\">\u003cmeta data-mint-head property=\"og:description\" content=\"How to index your files with Shade\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Shade\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.shade.inc/indexing-assets/indexing\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shade.mintlify.site/_mintlify/api/og/v2?division=Indexing+Assets\u0026amp;title=Indexing+Your+Files+with+Shade\u0026amp;description=How+to+index+your+files+with+Shade\u0026amp;theme=c672b07a23ab4eb1aff9077b\u0026amp;signature=ee25e2e08a4bcee235e8478e71950a38920c8abd5ba1047483cfce3875143841\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Indexing Your Files with Shade - Shade\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"How to index your files with Shade\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shade.mintlify.site/_mintlify/api/og/v2?division=Indexing+Assets\u0026amp;title=Indexing+Your+Files+with+Shade\u0026amp;description=How+to+index+your+files+with+Shade\u0026amp;theme=c672b07a23ab4eb1aff9077b\u0026amp;signature=ee25e2e08a4bcee235e8478e71950a38920c8abd5ba1047483cfce3875143841\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/shade/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Shade\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#855CF8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.shade.inc/indexing-assets/indexing\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/indexing-assets/indexing.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.shade.inc/#organization\",\"name\":\"Shade\",\"url\":\"https://docs.shade.inc\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintlify.s3-us-west-1.amazonaws.com/shade/logo/light.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.shade.inc#website\",\"name\":\"Shade\",\"url\":\"https://docs.shade.inc\",\"publisher\":{\"@id\":\"https://docs.shade.inc/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.shade.inc/indexing-assets/indexing#webpage\",\"url\":\"https://docs.shade.inc/indexing-assets/indexing\",\"name\":\"Indexing Your Files with Shade\",\"description\":\"How to index your files with Shade\",\"isPartOf\":{\"@id\":\"https://docs.shade.inc#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shade.inc/indexing-assets/indexing#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shade.inc/indexing-assets/indexing#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shade\",\"item\":\"https://docs.shade.inc\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Indexing Your Files with Shade\",\"item\":\"https://docs.shade.inc/indexing-assets/indexing\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.shade.inc/indexing-assets/indexing#article\",\"headline\":\"Indexing Your Files with Shade\",\"name\":\"Indexing Your Files with Shade\",\"description\":\"How to index your files with Shade\",\"url\":\"https://docs.shade.inc/indexing-assets/indexing\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shade.inc/indexing-assets/indexing#webpage\"},\"publisher\":{\"@id\":\"https://docs.shade.inc/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.shade.inc#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Shade\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Shade\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/indexing-assets/indexing.md","siteName":"Shade","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Getting Started with Shade","href":"/getting-started"},{"title":"Using Shade as a File Explorer","description":"How to use Shade as a File Explorer","href":"/shade-as-file-explorer"}]},{"group":"Indexing Assets","pages":[{"title":"Indexing Your Files with Shade","href":"/indexing-assets/indexing"},{"title":"Viewing Indexed Files","description":"Here's how to view all of your indexed files","href":"/indexing-assets/viewing"},{"title":"Resetting Your Shade Database","href":"/indexing-assets/reset"},{"title":"Indexing Audio Samples and SFX","href":"/indexing-assets/indexing-audio"},{"title":"Indexing Materials","href":"/indexing-assets/materials"}]},{"group":"Editing Metadata","pages":[{"title":"Updating Tags \u0026 Descriptions","href":"/metadata/updating-tags-and-descriptions"}]},{"group":"Studio","pages":[{"title":"Shade Server Quickstart","href":"/studio/overview"},{"group":"Platform Guides","pages":[{"title":null,"href":"/studio/quickstart/windows"},{"title":null,"href":"/studio/quickstart/mac"},{"title":null,"href":"/studio/quickstart/linux"}]}]}]},{"anchor":"API Reference","icon":"rectangle-terminal","pages":[{"title":"API Reference","href":"/api-reference/headless"}]},{"anchor":"Community","href":"https://discord.gg/DT752crBWp","icon":"discord"}]},"basePath":"","title":"Indexing Your Files with Shade - Shade","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}