search footage

Find moments inside videos and recordings: a phrase like “drone shot of the coast at golden hour” returns start and end times in source seconds, ready to place on a timeline. Two ranked groups: visual (frames matching the phrase, or a shot-log line) and spoken (transcript passages, with speaker where known); a recording answers in spoken alone. like, instead of query, finds shots that look like a moment of a video or a picture. refs or folder index the videos named first; refs with no query indexes without searching and makes a named item’s missing search vectors (card text, look). index, not_searched_by_title, visual_unavailable and on_computers (a video only on a computer, searched there) say what was not searched; indexing names the jobs to wait on. inspect_media mode shot_log lists one video’s shots in order. Free over what is indexed; indexing and search vectors are cloud processing.

POST

/

tools

/

search_footage

search footage

curl --request POST \
  --url https://eversince.ai/api/v1/tools/search_footage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

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

payload = {}
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({})
};

fetch('https://eversince.ai/api/v1/tools/search_footage', 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,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_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,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_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 default: for a key or a connected agent, one of the workspaces the user allowed it.

Body

application/json

query

string

What the moment shows or what is said in it, as a shot description: "a woman laughing at a kitchen table, morning light".

Minimum string length: 1

like

object

Instead of query: shots that look like this one. Only visual hits come back, the moment's own shot left out.

Show child attributes

refs

string[]

Only inside these videos or recordings (item refs), indexed first.

folder

string

Only the videos and recordings in this folder (path or id). Everything in it is indexed.

limit

integer

Hits per group. Default 20.

Required range: 1 <= x <= 60

speaker

string

Only spoken lines said by this person, by name or "Speaker 2".

Required string length: 1 - 80

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

Show child attributes

media

object[]

search footage

curl --request POST \
  --url https://eversince.ai/api/v1/tools/search_footage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

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

payload = {}
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({})
};

fetch('https://eversince.ai/api/v1/tools/search_footage', 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,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_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,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}