Files Resource

Description

The Files resource allows you to manage and retrieve information about files. This resource supports retrieving details of a specific file, listing all files, uploading files, obtaining download links, and deleting files.

How Files Are Created

A new entry in the Files resource is created in one of the following ways:

• You explicitly upload a new file (or video title) to the internal storage via the Uploads API (POST /files/uploads).
• A new output file is created by a successfully finished import/conversion job. Jobs create a new file entry for each output file produced, automatically and also add additional meta-data to previously uploaded input files, if available.

Note that detailed meta-information (like video/audio codec, playlength, resolution) will only be populated once the uploaded object was actually used in a conversion job.

Supported Methods

GET /files/[ID]

Retrieve information about a specific file. This includes details such as the file's metadata, associated job, video and audio tracks, and more.

For detailed information, see GET /files/[ID].

GET /files/

List all files, with options for filtering, sorting, and pagination. You can filter files by type, pipeline ID, job ID, and more.

For detailed information, see GET /files/.

POST /files/uploads

Initiate a new file upload session and obtain the credentials for uploading the file data to the internal storage.

For detailed information, see the Uploads Resource.

GET /files/downloads

Obtain an absolute, downloadable URL for a file stored on the internal store (also used to generate signed, AutoGraph-watermarked download links).

For detailed information, see the Downloads Resource.

DELETE /files/[ID]

Delete a specific file. This will remove the file's metadata and binary data if it is not hosted externally.

For detailed information, see DELETE /files/[ID].