Clone
1
Highlights API
Omarchy-Big-PC edited this page 2026-08-28 14:49:54 +01:00

Highlights API

Highlights are named time periods saved to media-mp4/highlights.json. The API is deliberately simple so an AI agent or script can append detections without touching any video.

List

curl http://127.0.0.1:8765/api/highlights

Create

With clock times:

curl -X POST http://127.0.0.1:8765/api/highlights \
  -H 'Content-Type: application/json' \
  -d '{"date":"2026-08-27","start_time":"09:26:40","end_time":"09:28:40","title":"Person at entrance"}'

With seconds-from-midnight and a duration:

curl -X POST http://127.0.0.1:8765/api/highlights \
  -H 'Content-Type: application/json' \
  -d '{"date":"20260827","start":34116,"duration":120,"title":"Delivery"}'

Accepted fields: date (YYYY-MM-DD or YYYYMMDD), start/start_time, end/end_time or duration, label/title (max 120 chars). Responses return the stored highlight including its assigned id.

Delete

curl -X DELETE "http://127.0.0.1:8765/api/highlights?id=3"

In the UI

Press Mark start, then Mark end at the end of the interesting part, type a name, press Add highlight. Highlights show in yellow on the timeline; click a highlight or the legend label to jump to the next one.