API Reference

Community

Shade

Website

Create a Collection

Body_create_collection_collections_post

Response Create Collection Collections Post

HTTPValidationError

Create a user collection

Introduction

Here's how you can get started with Shade today

Getting Started with Shade

Using Shade as a File Explorer

Indexing Your Files with Shade

Here's how to view all of your indexed files

Viewing Indexed Files

Resetting Your Shade Database

Tips and tricks for indexing audio samples & SFX

Indexing Audio Samples and SFX

Indexing Materials

How to update and change tags, descriptions, and metadata for assets

Updating Tags & Descriptions

Using Shade headless - embedding search into your applications

Headless

Starting and connecting to the Shade Server for the first time

Shade Server Quickstart

About Shade Server

Config

Server Status

Search for assets in the database. This is the primary search function and performs the visual search of your
assets.

Search Assets

Get the usage of all assets for analytics

Server Usage Analytics

Returns number of assets returned in search query

Assets Searched

Exit the backend if we haven't received a heartbeat in more than 3 seconds

Returns: None

Server Heartbeat

Kill Server

Export File Path

Add Asset to Source

Add Tags to Asset

Delete Assets

Asset Roots

Assets Linked to Other Assets

Get all the collections an asset belongs to

Asset Collections

Individual Assets

Visually Similar Assets

Amount of Assets For Each Type

Link to Assets

Link to Asset Types

Get a listing of all the assets in the database

All Assets

Move Assets

Remove Assets from Source

Asset Name

Download Assets

Asset Type

Get a list of images of objects detected in asset

Objects Detected in an Asset

Unlink Assets

Update Assets

Add Asset to Collection

Assets in a Collection

Delete a Collection

Get a Collection

Get Filters

Given an Asset ID, update the collections associated with the id.
Then collection_ids are now the only collections the asset belongs to.

Update Collections

Get a listing of all the collections in the database

All Collections

Delete Asset from Collection

Save Assets

Add Comments to Assets

Get Asset Comments

Convert Videos

Convert Images

Generate New Assets

Add Asset to Root

Indexing Status

Sync Asset Roots

Get Asset Root

Get the download progress of the models required for indexing.

Download Progress

Get Indexing Limit

Indexing Queue

Get the types of files that have been seen by the indexer

File Types Seen

Pause Indexing

Delete All Indexing Roots

Delete Specific Indexing Root

Get an asset from the index. This will return all data about that file as well as the id. This function can be
useful for looking up the shade id for a file given an input file path. The primary difference between this
route and the GET /assets/asset_id is that this runs with only the path. This is useful for looking up the Shade
id for a file given an input file path.

API Documentation

Endpoint Examples

Assets

Collections

Comments

Convert

Generate

Indexing

Models

Players

Previews

Remove Background

Search

Create a Collection

Body

Response