RenderIO
Api referenceFiles

List Files

Retrieve a paginated list of stored files, ordered by creation date.

List Files

GET /api/v1/files

Retrieve a paginated list of your stored files, ordered by creation date (newest first). Only non-deleted files are returned.

Authentication

Requires API key via X-API-KEY header.

Request

Headers

HeaderTypeRequiredDescription
X-API-KEYstringYesYour API key with ffsk_ prefix

Query parameters

ParameterTypeRequiredDefaultDescription
limitnumberNo50Number of files to return. Maximum 100.
offsetnumberNo0Number of files to skip for pagination.

Response

200 OK

{
  files: StoredFileResponse[];
  limit: number;
  offset: number;
}
FieldTypeDescription
filesStoredFileResponse[]Array of file objects. See Get File for the full StoredFileResponse shape.
limitnumberThe limit value used for this request.
offsetnumberThe offset value used for this request.

Error responses

StatusErrorDescription
400INVALID_REQUESTInvalid query parameters (e.g., limit exceeds 100).
401UNAUTHORIZEDMissing or invalid API key.
429RATE_LIMITEDToo many requests. Retry after the period indicated in the Retry-After header.

Examples

curl

# List the 20 most recent files
curl "https://renderio.dev/api/v1/files?limit=20" \
  -H "X-API-KEY: ffsk_your_api_key_here"

# Paginate through files
curl "https://renderio.dev/api/v1/files?limit=10&offset=10" \
  -H "X-API-KEY: ffsk_your_api_key_here"

JavaScript (fetch)

const params = new URLSearchParams({
  limit: "20",
  offset: "0",
});

const response = await fetch(
  `https://renderio.dev/api/v1/files?${params}`,
  {
    headers: {
      "X-API-KEY": "ffsk_your_api_key_here",
    },
  },
);

const { files, limit, offset } = await response.json();
console.log(`Fetched ${files.length} files (offset: ${offset})`);

for (const file of files) {
  console.log(`${file.file_id} - ${file.status} - ${file.size_mbytes} MB`);
}

Python (requests)

import requests

response = requests.get(
    "https://renderio.dev/api/v1/files",
    headers={
        "X-API-KEY": "ffsk_your_api_key_here",
    },
    params={
        "limit": 20,
        "offset": 0,
    },
)

data = response.json()
print(f"Fetched {len(data['files'])} files (offset: {data['offset']})")

for file in data["files"]:
    print(f"{file['file_id']} - {file['status']} - {file['size_mbytes']} MB")

On this page