Skip to main content
POST
inspect color

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 default: for a key or a connected agent, one of the workspaces the user allowed it.

Body

application/json
ref
string

The item to measure: an image, or a video with at_seconds. One of ref, refs or timeline_id.

refs
string[]

Up to 12 items measured the same way; one that cannot be read comes back as {ref, error}.

Required array length: 1 - 12 elements

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

timeline_id
string

Measure a composited frame of this timeline instead of an item.

key_color
string

A colorkey keyColor, #rrggbb. Returns key: how far the screen's pixels reach from it and where the rest of the picture begins, in the units of similarity, each point's distance, and a similarity and smoothness that fit.

Pattern: ^#?[0-9a-fA-F]{6}$
at_seconds
number

The moment to measure in a video item or a timeline, seconds. Default 0.

Required range: x >= 0
reference
string

An item to compare against (an image, or a video with reference_at_seconds); the gap comes back as grade-knob hints.

reference_at_seconds
number

The moment in the reference video, seconds. Default 0.

Required range: x >= 0
points
object[]

Points to read the exact color of, as fractions of the picture (0..1).

Maximum array length: 64
lines
object[]

Rows or columns to scan; each returns the runs where it is not the picture's ground. One of row or column each.

Maximum array length: 8

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