Skip to main content
GET
Search assets

Authorizations

Authorization
string
header
required

A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.

Query Parameters

projectId
string

Only assets in this project

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
folderId

Only assets directly in this folder, or unfiled for assets in no folder; with q, also its subfolders. Needs projectId

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
favorite
string

Only the organization's favorites

Allowed value: "true"
labelId
string[]

Only assets with any of these active labels; repeat the parameter

Maximum array length: 100
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
q
string

Search asset names: at least two characters, and every one of the first eight words must match, ignoring case

Required string length: 2 - 200
type
enum<string>

Only this media type

Available options:
image,
video,
audio,
model3d
origin
enum<string>

Only assets that came about this way

Available options:
generated,
upload,
derived
resolution
enum<string>[]

Only assets in any of these resolution tiers; repeat the parameter

Available options:
4k,
1440p,
1080p,
720p,
sd,
2k,
1k,
0.5k
sort
enum<string>

Order by creation; default newest

Available options:
newest,
oldest
limit
integer

Assets per page; default 20

Required range: 1 <= x <= 50
cursor
string

nextCursor from the previous page, with the same filters

Response

A page of assets.

data
object[]
required
nextCursor
string | null
required

Pass as cursor for the next page of assets; null on the last page