VisionAPI ReferenceVideo QA

Chat with Video QA

Chat with the video QA model.

Set stream=true to receive server-sent events (SSE) instead of a single response.

Authentication

X-Api-Keystring

API key authentication via X-Api-Key header

OR
AuthorizationBearer
Bearer token authentication via Authorization header

Request

This endpoint expects an object.
video_idstringRequired
The ID of the video to query.
user_idstring or nullOptional
Override user ID. Takes precedence over API key header when provided.
messageslist of objects or nullOptional
The conversation history. The last message must be from the user and contain the query.
streamboolean or nullOptionalDefaults to false

If true, stream the response using server-sent events (SSE).

apply_temporal_prefilteringboolean or nullOptionalDefaults to true

If true, apply temporal pre-filtering to narrow down the video timestamp search space.

include_demo_videosboolean or nullOptionalDefaults to false
If true, include demo videos in the QA flow.
use_map_reduce_summarizationboolean or nullOptionalDefaults to false

If true, use map-reduce summarization instead of one-shot summarization.

Response

Successful Response
chat_responsestring or map from strings to any or null
statusenum or nullDefaults to pending
Allowed values: