Skip to main content
GET
/
v1
/
files
Get list of all stored files
curl --request GET \
  --url https://api.rendi.dev/v1/files \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.rendi.dev/v1/files"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.rendi.dev/v1/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rendi.dev/v1/files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.rendi.dev/v1/files"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.rendi.dev/v1/files")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.rendi.dev/v1/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "file_id": "<string>",
    "environment_name": "main",
    "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,
    "file_count": 5,
    "size_compressed_mbytes": 15.2,
    "is_private": false
  }
]
{
"detail": "Invalid authorization key"
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

limit
integer
default:1000

Maximum number of files to return

Required range: x <= 1000
offset
integer
default:0

Number of files to skip before starting to collect the result set

Required range: x >= 0

Response

Successful Response

file_id
string
required

Unique identifier for the stored file

Example:

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

environment_name
string | null

The environment this file was stored in (e.g., 'main', 'test', 'dev').

Example:

"main"

storage_url
string | null

URL where the file is stored

Example:

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

status
enum<string> | null

Status of the file

Available options:
QUEUED,
DOWNLOADING,
DOWNLOADED,
UPLOADED,
FAILED,
STORED
Example:

"STORED"

rendi_store_type
enum<string> | null

Type of storage of the file in rendi

Available options:
INPUT,
OUTPUT,
STORED_FILE
Example:

"STORED_FILE"

error_status
string | null

Status of any error that occurred during file processing

Example:

"UNREACHABLE_INPUT_FILE"

external_error_message
string | null

Error details if the file failed to be processed

Example:

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

is_deleted
boolean | null

Whether the file has been deleted

Example:

false

size_mbytes
number | null

Size of the output file or folder in megabytes

Example:

15.2

file_count
integer | null

Number of files in the output folder/playlist

Example:

5

size_compressed_mbytes
number | null

Size of the output compressed folder in megabytes

Example:

15.2

is_private
boolean | null

Whether the file is stored privately. Private files are accessible via their storage_url only if you request a presigned URL by passing presigned_ttl_seconds on GET /v1/files/{file_id} (for a single file) or GET /v1/commands/{command_id} (for a command's output files) to receive a time-limited downloadable URL. Not available on free plans.

Example:

false