Skip to main content
POST
/
live-digest
Live Digest
curl --request POST \
  --url https://trio.machinefi.com/api/live-digest \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stream_url": "<string>",
  "window_minutes": 10,
  "webhook_url": "<string>",
  "capture_interval_seconds": 60,
  "max_windows": 2,
  "include_frames": false
}
'
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "stream_url": "<string>",
  "job_type": "<string>",
  "details": {},
  "message": "<string>"
}
Starts a summary-oriented monitoring job that samples the stream and emits narrative summaries. Use this when you need trend-level understanding over time, not binary trigger detection.

​
Delivery Mode Selection

POST /live-digest selects response mode by request shape:
  1. Accept: text/event-stream and no webhook_url -> SSE mode
  2. webhook_url present -> webhook mode
  3. otherwise -> polling mode

​
Response Semantics by Mode

​
Polling mode

Returns a job response (job_id, status, created_at, job_type, stream_url, optional message). Follow with GET /jobs/{job_id} for runtime details and summary outcomes.

​
Webhook mode

Returns a job response immediately, then delivers async summary/status events. Common webhook type values:
  • job_started
  • summary_generated
  • job_stopped
  • error

​
SSE mode

Returns live text events. Common event names:
  • started
  • progress
  • summary
  • stopped
  • error
Treat stopped and error as terminal events for that stream session.

​
Tuning Semantics

  • window_minutes: coverage duration per summary
  • capture_interval_seconds: sampling cadence
  • max_windows: optional cap on total windows
Tune these together with your latency/cost requirements.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
accept
string
default:application/json

Body

application/json

Request to start a live digest job (SSE streaming).

​
stream_url
string
required

YouTube Live URL or RTSP stream to digest

Required string length: 1 - 500
​
window_minutes
integer
default:10

Time window in minutes

Required range: 1 <= x <= 60
​
webhook_url
string<uri> | null

Webhook URL for notifications

Required string length: 1 - 2083
​
capture_interval_seconds
integer
default:60

Frame capture interval

Required range: 10 <= x <= 300
​
max_windows
integer | null

Stop after N summaries. None = run until max duration

Required range: x >= 1
​
include_frames
boolean
default:false

Include base64 frame grid in summary events

Response

Successful Response

Response containing job information.

​
job_id
string<uuid>
required
​
status
enum<string>
required

Job status enum.

Available options:
pending,
running,
stopped,
completed,
failed
​
created_at
string
required
​
stream_url
string
required
​
job_type
string
required
​
details
Details · object
​
message
string | null