GET
/
v1
/
files
/
{file_id}
Get Stored File
curl --request GET \
  --url https://api.rendi.dev/v1/files/{file_id} \
  --header 'X-API-KEY: <api-key>'
{
  "file_id": "987fcdeb-a89b-43d3-b456-789012345678",
  "storage_url": "https://storage.rendi.dev/123e4567-e89b-12d3-a456-426614174000/output.avi",
  "status": "STORED",
  "rendi_store_type": "STORED_FILE",
  "error_status": "UNREACHABLE_INPUT_FILE",
  "external_error_message": "Input file url https://rendi.dev/example is not reachable.",
  "is_deleted": false,
  "size_mbytes": 15.2,
  "original_file_url": "https://somehwereonline.stored.com/file_to_store.mp4",
  "duration": 30.5,
  "file_type": "video",
  "file_format": "avi",
  "width": 1920,
  "height": 1080,
  "codec": "msmpeg4v2",
  "frame_rate": 30,
  "bitrate_video_kb": 4000,
  "bitrate_audio_kb": 128,
  "video_profile_level": "main",
  "is_varying_frame_rate": false
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
file_id
string
required

The UUID of the file to get

Response

Successful Response

Represents a file stored by rendi. Could either be an uploaded file or a file generated by running a command.

This model contains metadata about files stored in rendi storage, including file details, media information, and storage location.

​
file_id
string
required

Unique identifier for the stored file

Examples:

"987fcdeb-a89b-43d3-b456-789012345678"

​
storage_url
string | null

URL where the file is stored

Examples:

"https://storage.rendi.dev/123e4567-e89b-12d3-a456-426614174000/output.avi"

​
status
enum<string> | null

Status of the file

Available options:
QUEUED,
DOWNLOADING,
DOWNLOADED,
FAILED,
STORED
Examples:

"STORED"

​
rendi_store_type
enum<string> | null

Type of storage of the file in rendi

Available options:
INPUT,
OUTPUT,
STORED_FILE
Examples:

"STORED_FILE"

​
error_status
string | null

Status of any error that occurred during file processing

Examples:

"UNREACHABLE_INPUT_FILE"

​
external_error_message
string | null

Error details if the file failed to be processed

Examples:

"Input file url https://rendi.dev/example is not reachable."

​
is_deleted
boolean | null

Whether the file has been deleted

Examples:

false

​
size_mbytes
number | null

Size of the output file in megabytes

Examples:

15.2

​
original_file_url
string | null

URL of the original file

Examples:

"https://somehwereonline.stored.com/file_to_store.mp4"

​
duration
number | null

Duration of the media file in seconds

Examples:

30.5

​
file_type
string | null

Type of the media file (video, audio, image, subtitles, etc.)

Examples:

"video"

​
file_format
string | null

Format/container of the media file

Examples:

"avi"

​
width
integer | null

Width of the video in pixels

Examples:

1920

​
height
integer | null

Height of the video in pixels

Examples:

1080

​
codec
string | null

Codec used for the media file

Examples:

"msmpeg4v2"

​
frame_rate
number | null

Frame rate of the video in frames per second

Examples:

30

​
bitrate_video_kb
number | null

Video bitrate in kilobits per second

Examples:

4000

​
bitrate_audio_kb
number | null

Audio bitrate in kilobits per second

Examples:

128

​
video_profile_level
string | null

Video profile level

Examples:

"main"

​
is_varying_frame_rate
boolean | null

Whether the video has a variable frame rate

Examples:

false