Get list of all stored files

Get the list of all stored files for an account, ordered by creation time - descending. Can return command output files or stored files. Will not return deleted files or input files.

get/v1/files

Request

Base URL
https://api.rendi.dev
URL
https://api.rendi.dev/v1/files
Auth
API key in header X-API-KEY

Query parameters

limitinteger

Maximum number of files to return

offsetinteger

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

Response

Successful Response

file_idstring required

Unique identifier for the stored file

environment_namestring nullable

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

storage_urlstring nullable

URL where the file is stored

rendi_store_type'INPUT' | 'OUTPUT' | 'STORED_FILE'

error_statusstring nullable

Status of any error that occurred during file processing

external_error_messagestring nullable

Error details if the file failed to be processed

is_deletedboolean nullable

Whether the file has been deleted

size_mbytesnumber nullable

Size of the output file or folder in megabytes

file_countinteger nullable

Number of files in the output folder/playlist

size_compressed_mbytesnumber nullable

Size of the output compressed folder in megabytes

is_privateboolean nullable

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 response

[
  {
    "file_id": "987fcdeb-a89b-43d3-b456-789012345678",
    "environment_name": "main",
    "storage_url": "https://storage.rendi.dev/123e4567-e89b-12d3-a456-426614174000/output.avi",
    "error_status": "UNREACHABLE_INPUT_FILE",
    "external_error_message": "Input file url https://rendi.dev/example is not reachable.",
    "size_mbytes": 15.2,
    "file_count": 5,
    "size_compressed_mbytes": 15.2
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.