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.

Query Parameters

path

string

required

The path to the file to lookup

Response

200 - application/json

id

string

required

name

string

required

description

string

required

signature

integer

required

updated

string

required

created

string

required

path

string

required

type

enum<string>

required

An 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[]

required

size_bytes

integer

required

source

string[]

required

objects

any[]

required

blurhash

string

required

palette

array

required

extension

string

required

license

enum<string>

required

Asset 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

required

preview_images

object[]

required

Show child attributes

ai_indexed

boolean

required

comments

object[]

required

Show child attributes

user_description

string

file_created

string

file_modified

string

timestamp

integer

transcription

string

rating

number

ocr

string

category

string

texture_data

object

integration_data

object

proxy_path

string

candid

boolean

faces_present

boolean

red_eye

boolean

eyes_open

boolean

people_posing

boolean

blurry

boolean

focused

boolean

good_exposure

boolean

players

object[]

Show child attributes