Collections
All Collections
- Documentation
- API Reference
- Community
- Headless
- GETAbout Shade Server
- GETConfig
- GETServer Status
- GETSearch Assets
- GETServer Usage Analytics
- GETAssets Searched
- GETServer Heartbeat
- GETKill Server
- GETExport File Path
- POSTAdd Asset to Source
- PUTAdd Tags to Asset
- DELDelete Assets
- GETAsset Roots
- GETAssets Linked to Other Assets
- GETAsset Collections
- GETIndividual Assets
- GETVisually Similar Assets
- GETAmount of Assets For Each Type
- POSTLink to Assets
- POSTLink to Asset Types
- GETAll Assets
- POSTMove Assets
- DELRemove Assets from Source
- PUTAsset Name
- GETDownload Assets
- GETAsset Type
- GETObjects Detected in an Asset
- DELUnlink Assets
- PUTUpdate Assets
- POSTAdd Asset to Collection
- GETAssets in a Collection
- POSTCreate a Collection
- DELDelete a Collection
- GETGet a Collection
- GETGet Filters
- PUTUpdate Collections
- GETAll Collections
- DELDelete Asset from Collection
- POSTSave Assets
- PUTUpdate Collections
- POSTGenerate New Assets
- POSTAdd Asset to Root
- GETIndexing Status
- POSTSync Asset Roots
- GETGet Asset Root
- GETDownload Progress
- GETGet Indexing Limit
- GETIndexing Queue
- GETFile Types Seen
- POSTPause Indexing
- DELDelete All Indexing Roots
- DELDelete Specific Indexing Root
- GETAsset from Index
- POSTReset Indexing
- POSTSet Indexing Limit
- PUTUpdate Player Numbers
- POSTRemove Background
- GETSearch Assets
API Documentation
Endpoint Examples
Assets
Collections
Generate
Indexing
Players
Remove Background
Search
Collections
All Collections
Get a listing of all the collections in the database
GET
/
collections
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"type": "auto",
"tags": [
"string"
],
"filters": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"preview_asset": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"user_description": "string",
"description": "string",
"signature": 0,
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"file_created": "2019-08-24T14:15:22Z",
"file_modified": "2019-08-24T14:15:22Z",
"timestamp": 0,
"path": "string",
"type": "IMAGE",
"tags": [
"string"
],
"size_bytes": 0,
"source": [
"string"
],
"objects": [
null
],
"transcription": "string",
"rating": 0,
"blurhash": "string",
"palette": [
[
0
]
],
"ocr": "string",
"category": "string",
"extension": "string",
"license": "cc-by",
"asset_metadata": {},
"preview_images": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"thumbnail": "string",
"created": "2019-08-24T14:15:22Z"
}
],
"texture_data": {},
"integration_data": {},
"proxy_path": "string",
"ai_indexed": true,
"comments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
],
"candid": true,
"faces_present": true,
"red_eye": true,
"eyes_open": true,
"people_posing": true,
"blurry": true,
"focused": true,
"good_exposure": true,
"players": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"number": 0,
"image_blob": "string"
}
]
},
"preview_image": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"thumbnail": "string",
"created": "2019-08-24T14:15:22Z"
}
}
]
Response
200 - application/json
id
string
requiredname
string
requireddescription
string
requiredtype
enum<string>
requiredAn enumeration.
Available options:
auto, user tags
string[]
requiredfilters
object
requiredpreview_asset
object
preview_asset.id
string
requiredpreview_asset.name
string
requiredpreview_asset.user_description
string
preview_asset.description
string
requiredpreview_asset.signature
integer
requiredpreview_asset.updated
string
requiredpreview_asset.created
string
requiredpreview_asset.file_created
string
preview_asset.file_modified
string
preview_asset.timestamp
integer
preview_asset.path
string
requiredpreview_asset.type
enum<string>
requiredAn enumeration.
Available options:
IMAGE, VIDEO, AUDIO, OBJECT, MAYA, NUKE, MAX, HDR, HDRI, BLENDER, HOUDINI, PHOTOSHOP, UNREAL, UNITY, TEXTURE, SEQUENCE, AFTER_EFFECTS, MOGRT, ILLUSTRATOR, EXR, DOCUMENT, STOCK, OTHER preview_asset.tags
string[]
requiredpreview_asset.size_bytes
integer
requiredpreview_asset.source
string[]
requiredpreview_asset.objects
any[]
requiredpreview_asset.transcription
string
preview_asset.rating
number
preview_asset.blurhash
string
requiredpreview_asset.palette
array
requiredpreview_asset.ocr
string
preview_asset.category
string
preview_asset.extension
string
requiredpreview_asset.license
enum<string>
requiredAsset Licenses
Available options:
cc-by, cc-by-sa, cc-by-nd, cc-by-nc, cc-by-nc-sa, cc-by-nc-nd, cc0, unknown, other preview_asset.asset_metadata
object
requiredpreview_asset.preview_images
object[]
requiredpreview_asset.preview_images.id
string
requiredpreview_asset.preview_images.path
string
requiredpreview_asset.preview_images.thumbnail
string
requiredpreview_asset.preview_images.created
string
requiredpreview_asset.texture_data
object
preview_asset.integration_data
object
preview_asset.proxy_path
string
preview_asset.ai_indexed
boolean
requiredpreview_asset.comments
object[]
requiredpreview_asset.comments.id
string
requiredpreview_asset.comments.content
string
requiredpreview_asset.comments.created
string
requiredpreview_asset.comments.updated
string
requiredpreview_asset.candid
boolean
preview_asset.faces_present
boolean
preview_asset.red_eye
boolean
preview_asset.eyes_open
boolean
preview_asset.people_posing
boolean
preview_asset.blurry
boolean
preview_asset.focused
boolean
preview_asset.good_exposure
boolean
preview_asset.players
object[]
preview_asset.players.id
string
requiredpreview_asset.players.number
integer
requiredpreview_asset.players.image_blob
string
requiredpreview_image
object
preview_image.id
string
requiredpreview_image.path
string
requiredpreview_image.thumbnail
string
requiredpreview_image.created
string
required[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"type": "auto",
"tags": [
"string"
],
"filters": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"preview_asset": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"user_description": "string",
"description": "string",
"signature": 0,
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"file_created": "2019-08-24T14:15:22Z",
"file_modified": "2019-08-24T14:15:22Z",
"timestamp": 0,
"path": "string",
"type": "IMAGE",
"tags": [
"string"
],
"size_bytes": 0,
"source": [
"string"
],
"objects": [
null
],
"transcription": "string",
"rating": 0,
"blurhash": "string",
"palette": [
[
0
]
],
"ocr": "string",
"category": "string",
"extension": "string",
"license": "cc-by",
"asset_metadata": {},
"preview_images": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"thumbnail": "string",
"created": "2019-08-24T14:15:22Z"
}
],
"texture_data": {},
"integration_data": {},
"proxy_path": "string",
"ai_indexed": true,
"comments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
],
"candid": true,
"faces_present": true,
"red_eye": true,
"eyes_open": true,
"people_posing": true,
"blurry": true,
"focused": true,
"good_exposure": true,
"players": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"number": 0,
"image_blob": "string"
}
]
},
"preview_image": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"thumbnail": "string",
"created": "2019-08-24T14:15:22Z"
}
}
]