Shade home page

Website
Website

API Documentation

Headless

Endpoint Examples

GET
About Shade Server
GET
Config
GET
Server Status
GET
Search Assets
GET
Server Usage Analytics
GET
Assets Searched
GET
Server Heartbeat
GET
Kill Server
GET
Export File Path

Assets

POST
Add Asset to Source
PUT
Add Tags to Asset
DEL
Delete Assets
GET
Asset Roots
GET
Assets Linked to Other Assets
GET
Asset Collections
GET
Individual Assets
GET
Visually Similar Assets
GET
Amount of Assets For Each Type
POST
Link to Assets
POST
Link to Asset Types
GET
All Assets
POST
Move Assets
DEL
Remove Assets from Source
PUT
Asset Name
GET
Download Assets
GET
Asset Type
GET
Objects Detected in an Asset
DEL
Unlink Assets
PUT
Update Assets

Collections

POST
Add Asset to Collection
GET
Assets in a Collection
POST
Create a Collection
DEL
Delete a Collection
GET
Get a Collection
GET
Get Filters
PUT
Update Collections
GET
All Collections
DEL
Delete Asset from Collection
POST
Save Assets
PUT
Update Collections

Comments

POST
Add Comments to Assets
GET
Get Asset Comments

Convert

POST
Convert Videos
POST
Convert Images

Generate

POST
Generate New Assets

Indexing

POST
Add Asset to Root
GET
Indexing Status
POST
Sync Asset Roots
GET
Get Asset Root
GET
Download Progress
GET
Get Indexing Limit
GET
Indexing Queue
GET
File Types Seen
POST
Pause Indexing
DEL
Delete All Indexing Roots
DEL
Delete Specific Indexing Root
GET
Asset from Index
POST
Reset Indexing
POST
Set Indexing Limit

Models

DEL
Delete a Model
POST
Download a Model

Players

PUT
Update Player Numbers

Previews

GET
Image Bytes from Preview
POST
Get Preview

Remove Background

POST
Remove Background

Search

GET
Search Assets

Copy

"<string>"

Remove Background

Remove Background

POST

/

remove-background

Copy

"<string>"

Body

application/json

Response

Successful Response

The response is of type string.

Get Preview Search Assets

twitter github linkedin website discord

Powered by Mintlify

Assistant

Responses are generated using AI and may contain mistakes.