v1

latestOpenAPI 3.1.02026-07-266827131.9 KB

Stream Understanding

Start Stream Video Understanding

Start a real-time AI analysis session on a live RTMP video stream.

post/v1/understand/streamConnect

Request body

urlstring required

RTMP stream URL for live video input

user_promptstring required

Analysis instruction applied to each frame window

system_promptstring required

Role or context for the AI

callbackstring required

Public URL to receive continuous analysis results

thinkingboolean

Enable reasoning mode for deeper analysis

Example request

{
  "url": "rtmp://your.server:1935/live/stream",
  "user_prompt": "What is happening right now?",
  "system_prompt": "You are a real-time video monitoring system.",
  "callback": "https://your.app/callback"
}

Response

Stream started successfully

statusinteger

task_idstring

textstring

Example response

{
  "task_id": "5347085a-1747-4731-bdde-3856d09502c4"
}