Skip to main content
POST
Describe a video with shots, OCR, and transcript

Authorizations

Authorization
string
header
required

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

Body

application/json
video_url
string<uri>
required
model
string | null
detail
enum<string>
default:auto
Available options:
auto,
short,
long
frame_sample_rate
number
default:1
Required range: 0.5 <= x <= 2

Response

200 - application/json

Video description.

id
string
object
string
Allowed value: "video.description"
model
string
summary
string
duration_seconds
number | null
shots
object[]
on_screen_text
string[]
spoken_transcript
string
usage
object