inspect color

Measure a still as scopes: black and white points, crushed and blown fractions, mean brightness, a luma histogram, shadow, mid and highlight balance, saturation, warm-cool and green-magenta bias, and a hue histogram. Takes an image item, one moment of a video item, or one composited frame of a timeline. With reference, the gap comes back as first-order hints on the grade fields a clip carries, to apply with updateClip and check on a rendered frame. Free, except drawing a timeline frame: cloud processing.

POST

tools

inspect_color

inspect color

curl --request POST \
  --url https://eversince.ai/api/v1/tools/inspect_color \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": "<string>",
  "timeline_id": "<string>",
  "at_seconds": 1,
  "reference": "<string>",
  "reference_at_seconds": 1
}
'

import requests

url = "https://eversince.ai/api/v1/tools/inspect_color"

payload = {
    "ref": "<string>",
    "timeline_id": "<string>",
    "at_seconds": 1,
    "reference": "<string>",
    "reference_at_seconds": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ref: '<string>',
    timeline_id: '<string>',
    at_seconds: 1,
    reference: '<string>',
    reference_at_seconds: 1
  })
};

fetch('https://eversince.ai/api/v1/tools/inspect_color', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}

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

ref

string

The item to measure: an image, or a video with at_seconds. Give this or timeline_id.

timeline_id

string

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

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

Response

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

any

required

data

object

required

meta

object

required

Show child attributes

media

object[]

inspect color

curl --request POST \
  --url https://eversince.ai/api/v1/tools/inspect_color \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": "<string>",
  "timeline_id": "<string>",
  "at_seconds": 1,
  "reference": "<string>",
  "reference_at_seconds": 1
}
'

import requests

url = "https://eversince.ai/api/v1/tools/inspect_color"

payload = {
    "ref": "<string>",
    "timeline_id": "<string>",
    "at_seconds": 1,
    "reference": "<string>",
    "reference_at_seconds": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ref: '<string>',
    timeline_id: '<string>',
    at_seconds: 1,
    reference: '<string>',
    reference_at_seconds: 1
  })
};

fetch('https://eversince.ai/api/v1/tools/inspect_color', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}

Discovery

Timeline

Workspace

Library

Canvas

Generation

Research

Account

Models

Uploads

Webhooks

inspect color

Authorizations

Headers

Body

Response