POST
/
v1
/
video
/
generate
"<any>"

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request to the Video API (i.e. structured prediction).

​
domain
enum<string>
required

The domain identifier for the model (e.g. video.transcription).

Available options:
video.transcription,
video.transcription-summary,
video.product-demo-summary,
video.conferencing-summary,
video.podcast-summary,
video.summary,
video.dashcam-analytics
​
metadata
object

Optional metadata to pass to the model.

​
config
object

The VLM generation config to be used for /<dtype>/generate.

​
url
string | null

The URL of the file (provide either file_id or url).

​
file_id
string | null

The ID of the uploaded file (provide either file_id or url).

​
id
string

Unique identifier of the request.

​
created_at
string<date-time>

Date and time when the request was created (in UTC timezone)

​
callback_url
string<uri> | null

The URL to call when the request is completed.

Minimum length: 1
​
model
string
default:vlm-1

The model to use for generating the response.

Allowed value: "vlm-1"
​
batch
boolean
default:true

Whether to process the document in batch mode (async).

Response

Successful Response

The response is of type any.