Skip to main content
POST
get items

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
refs
string[]
required

25 a time; the rest come back named in truncated.

Minimum array length: 1

An item ref, item id, or the job id that made it.

fields
enum<string>[]

Only these parts, each one a read of its own. All of them by default.

Available options:
labels,
lineage,
comments,
versions,
variations,
understanding
response_format
enum<string>

concise is the item alone: what it is, its file, technical, description, tags and fields. detailed (the default) adds every part around it.

Available options:
concise,
detailed

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