Skip to main content
POST
search library

Authorizations

Authorization
string
header
required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key
string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id
string

The workspace this one call acts in, when it is not the key's own.

Body

application/json
query
string
duplicates_of
string

Instead of a search: near-identical files to this item (a crop, a re-export, a version saved twice), closest first, each saying how it matched. limit applies; the other filters do not.

type
enum<string>

A recording is a video (camera or screen) or an audio item.

Available options:
image,
video,
audio,
document
folder
string

Folder path ("campaigns/july") or id.

subfolders
boolean

With folder: everything under it too, all the way down.

added_from
string

Added on or after: an ISO date or date-time, UTC (manage_settings carries the user's time zone; rows return added times in UTC). A bare date is its whole UTC day.

added_to
string

Added on or before, the same way.

modified_from
string

Last changed on or after.

modified_to
string

Last changed on or before.

sort
enum<string>

Order: newest or oldest added, most recently modified, name A to Z, or largest first. Without a query the default is newest; with one, relevance.

Available options:
newest,
oldest,
modified,
name,
size
favorite
boolean

true for starred items only, false for the rest.

stored
enum<string>

cloud: the bytes are with us, so any tool can read them. local: only on a user's computer until synced.

Available options:
cloud,
local
source
enum<string>

Narrow to how the item came about: assets (what was uploaded or imported), generations (what a model made here), or pulled (posts kept off a platform with keep_posts).

Available options:
assets,
generations,
pulled
label
string

Only items carrying this label (by name).

timeline
string

Only this timeline's media and docs (timeline_media): what its cut uses plus what was attached to it. The scope to search first when working a timeline; the whole library stays one call away.

fields
object

Custom field filters, name → required value.

hidden
boolean

true for what the user hid from their feed (still in the library), false for what still shows there. Results carry hidden: true.

limit
integer

Per page. Default 30.

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

next_cursor from the page before, with the same query and filters.

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok
any
required
data
object
required
meta
object
required
media
object[]