Indexing
Asset from Index
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.
GET
/
indexing
/
file
Query Parameters
path
string
requiredThe path to the file to lookup
Response
200 - application/json
id
string
requiredname
string
requireduser_description
string
description
string
requiredsignature
integer
requiredupdated
string
requiredcreated
string
requiredfile_created
string
file_modified
string
timestamp
integer
path
string
requiredtype
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
tags
string[]
requiredsize_bytes
integer
requiredsource
string[]
requiredobjects
any[]
requiredtranscription
string
rating
number
blurhash
string
requiredpalette
array
requiredocr
string
category
string
extension
string
requiredlicense
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
asset_metadata
object
requiredpreview_images
object[]
requiredtexture_data
object
integration_data
object
proxy_path
string
ai_indexed
boolean
requiredcomments
object[]
requiredcandid
boolean
faces_present
boolean
red_eye
boolean
eyes_open
boolean
people_posing
boolean
blurry
boolean
focused
boolean
good_exposure
boolean
players
object[]