Video Management
For chat over text, images and short videos, use the OpenAI-compatible Chat Completions API.
Videos are the core resource of the Vision API. Uploading a video stores it without processing it. Once the upload finishes, run the video features you need (transcript, captions, embeddings, objects) before searching or chatting with it.
Upload a video
Send a POST /v2/videos request as multipart/form-data, with either a file or a video_url. The endpoint returns 202 Accepted while the upload continues in the background.
Upload a local file
Bash
Python
Upload from a URL
Bash
Python
Upload parameters
file(optional): Video file to upload. Send eitherfileorvideo_url.video_url(optional): URL to download the video from.video_name(optional): Display name for the video. Required for file uploads.group_id(optional): ID of the video group to associate the video with.description(optional): Video description.
Upload response
video_id: Unique identifier for the uploaded video.status: Upload status, one ofuploading,uploaded, orfailed.metadata: Video metadata, populated after the upload completes.
Get a video
GET /v2/videos/{video_id} returns the upload status, metadata, and per-feature processing status for one video.
Bash
Python
Video response
video_id: Unique identifier for the video.url: Presigned URL to access the video.status: Upload status (uploading,uploaded,failed).metadata: Dimensions, frame rate, name, title, start timestamp in milliseconds, duration in seconds, thumbnail URL, storyboard thumbnails URL (typically VTT), description, and source.features: Processing status for each feature, one ofnone,pending,processing,ready,failed, orblocked. See Video Features.group_id: ID of the group the video belongs to, if any.error: Error message if the upload or download failed.
List videos
GET /v2/videos lists every video you own, across all groups. Pass ids one or more times to return only those videos.
Bash
Python
The response wraps the videos in a results array, each entry shaped like the video response above.
Update a video
PATCH /v2/videos/{video_id} changes a video’s name, title, or description, or moves it to another group. Fields you omit or set to null stay unchanged. The target group must exist and belong to you.
Bash
Python
Update parameters
name(optional): Display name shown in listings and search results.title(optional): Video title.description(optional): Video description.group_id(optional): Group to move the video to.
The response is the updated video.
Delete a video
DELETE /v2/videos/{video_id} deletes a single video.