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>'
[
  {
    "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
  }
]

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
limit
integer
default:1000

Maximum number of files to return

Required range: 0 < 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

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