Get File Information
- CLI
- Python SDK
- JavaScript SDK
Get file info by ID:Get file info by filename:Example Output:
Copy
gravixlayer files info file-abc123def456
Copy
gravixlayer files info document.pdf
Copy
File Information:
File ID: file-abc123def456
Filename: document.pdf
Size: 2048576 bytes
Purpose: batch
Created: 2025-09-03T15:57:47.021738Z
Status: processed
Copy
import os
from gravixlayer import GravixLayer
client = GravixLayer()
# Get file info by ID
file_info = client.files.retrieve("file-abc123def456")
print(f"Filename: {file_info.filename}")
print(f"Size: {file_info.bytes} bytes")
print(f"Purpose: {file_info.purpose}")
print(f"Created: {file_info.created_at}")
print(f"Status: {file_info.status}")
Copy
import { GravixLayer } from 'gravixlayer';
const client = new GravixLayer({
apiKey: process.env.GRAVIXLAYER_API_KEY,
});
// Get file info by ID
const fileInfo = await client.files.retrieve("file-abc123def456");
console.log(`Filename: ${fileInfo.filename}`);
console.log(`Size: ${fileInfo.bytes} bytes`);
console.log(`Purpose: ${fileInfo.purpose}`);
console.log(`Created: ${fileInfo.created_at}`);
console.log(`Status: ${fileInfo.status}`);
Get Multiple File Details
- Python SDK
- JavaScript SDK
Copy
import os
from gravixlayer import GravixLayer
client = GravixLayer()
# Get details for multiple files
file_ids = ["file-abc123", "file-def456", "file-ghi789"]
for file_id in file_ids:
try:
file_info = client.files.retrieve(file_id)
print(f"File: {file_info.filename}")
print(f" Size: {file_info.bytes} bytes")
print(f" Purpose: {file_info.purpose}")
print(f" Status: {file_info.status}")
print("---")
except Exception as e:
print(f"Error retrieving {file_id}: {e}")
Copy
import { GravixLayer } from 'gravixlayer';
const client = new GravixLayer({
apiKey: process.env.GRAVIXLAYER_API_KEY,
});
// Get details for multiple files
const fileIds = ["file-abc123", "file-def456", "file-ghi789"];
for (const fileId of fileIds) {
try {
const fileInfo = await client.files.retrieve(fileId);
console.log(`File: ${fileInfo.filename}`);
console.log(` Size: ${fileInfo.bytes} bytes`);
console.log(` Purpose: ${fileInfo.purpose}`);
console.log(` Status: ${fileInfo.status}`);
console.log("---");
} catch (error) {
console.log(`Error retrieving ${fileId}: ${error.message}`);
}
}
Check File Status
- Python SDK
- JavaScript SDK
Copy
import os
from gravixlayer import GravixLayer
client = GravixLayer()
def check_file_status(file_id):
try:
file_info = client.files.retrieve(file_id)
status = file_info.status
if status == "processed":
print(f"✅ File {file_info.filename} is ready for use")
elif status == "processing":
print(f"⏳ File {file_info.filename} is still processing")
elif status == "error":
print(f"❌ File {file_info.filename} failed to process")
else:
print(f"ℹ️ File {file_info.filename} status: {status}")
return status
except Exception as e:
print(f"Error checking file status: {e}")
return None
# Check status of a file
file_status = check_file_status("your-file-id")
Copy
import { GravixLayer } from 'gravixlayer';
const client = new GravixLayer({
apiKey: process.env.GRAVIXLAYER_API_KEY,
});
async function checkFileStatus(fileId) {
try {
const fileInfo = await client.files.retrieve(fileId);
const status = fileInfo.status;
if (status === "processed") {
console.log(`✅ File ${fileInfo.filename} is ready for use`);
} else if (status === "processing") {
console.log(`⏳ File ${fileInfo.filename} is still processing`);
} else if (status === "error") {
console.log(`❌ File ${fileInfo.filename} failed to process`);
} else {
console.log(`ℹ️ File ${fileInfo.filename} status: ${status}`);
}
return status;
} catch (error) {
console.log(`Error checking file status: ${error.message}`);
return null;
}
}
// Check status of a file
const fileStatus = await checkFileStatus("your-file-id");
Info Command Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_id_or_name | string | Yes | File ID (e.g., 977ca95b-0705-4ad2-846e-7d3d15af3eb2) or filename (e.g., README.md) |