Api referenceFiles
List Files
Retrieve a paginated list of stored files, ordered by creation date.
List Files
GET /api/v1/filesRetrieve 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
| Header | Type | Required | Description |
|---|---|---|---|
X-API-KEY | string | Yes | Your API key with ffsk_ prefix |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | number | No | 50 | Number of files to return. Maximum 100. |
offset | number | No | 0 | Number of files to skip for pagination. |
Response
200 OK
{
files: StoredFileResponse[];
limit: number;
offset: number;
}| Field | Type | Description |
|---|---|---|
files | StoredFileResponse[] | Array of file objects. See Get File for the full StoredFileResponse shape. |
limit | number | The limit value used for this request. |
offset | number | The offset value used for this request. |
Error responses
| Status | Error | Description |
|---|---|---|
400 | INVALID_REQUEST | Invalid query parameters (e.g., limit exceeds 100). |
401 | UNAUTHORIZED | Missing or invalid API key. |
429 | RATE_LIMITED | Too 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")