API Documentation

Get File Details

GET/vimoo/api/v1/files/{file_id}

AuthorizationHeader · RequiredGet an API Key ↗

Use file_id to retrieve file information and an access URL for the current account.

file_idstring: File identifier
file_typeinteger: 0: Unspecified; 1: Input image; 2: Generated video
file_namestring: Filename
content_typestring: MIME type
file_sizeinteger: File size in bytes
tagstring: Custom tag
statusinteger: 0: Unspecified; 1: Available; 2: Expired; 3: Failed; 4: Uploading
expire_atinteger: Expiration time in Unix seconds. New files are retained for 3 months by default; use the returned value
created_atinteger: Creation time
updated_atinteger: Last update time
file_urlstring: File access URL; video URLs are temporary and may expire at any time
task_nostring: Task number associated with a generated video; optional and usually absent for input images
modelstring: Model identifier associated with a generated video; optional and usually absent for input images
media_infoobject: Optional media information for a generated video, including duration, resolution, and ratio; usually absent for input images

Example successful response:

For a generated video, file_type is 2 and file_url is the video playback URL. To retrieve the cover image, use Get Task Results.

See Responses and Error Codes for error response formats and error codes.