FileInfo
FileInfo contains metadata about a file
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
fileId | string | Optional | Stable identifier of the stored file. |
name | string | Optional | Name of the file within its containing folder. |
path | string | Optional | Full path (e.g., "/documents/report.pdf"). |
folderPath | string | Optional | Parent folder path. |
sizeBytes | string (int64) | Optional | Size of the file content, in bytes. Pattern: ^-?\d+$. |
contentType | string | Optional | Media type describing the file or response body. |
uploadedAt | string | Optional | RFC3339 timestamp. |
modifiedAt | string | Optional | RFC3339 timestamp. |
metadata | Map from string to string | Optional | Custom metadata. |
tags | Array of string | Optional | User-defined tags. |
description | string | Optional | Optional description. |
storageRef | ObjectRef | Optional | Reference to actual storage location. |
checksum | string | Optional | File checksum (SHA256). |
version | integer (int32) | Optional | Version number (for versioning support). Minimum: -2147483648. Maximum: 2147483647. |
Where used
| Reference | Relationship |
|---|---|
| Generate a pre-signed download URL | POST /api/v1/storage/generate-download-url |
| Get file metadata | POST /api/v1/storage/get-file-metadata |
| Get storage state | POST /api/v1/storage/get-state |
| List files and folders in a directory | POST /api/v1/storage/list-files |
| Move or rename a file | POST /api/v1/storage/move-file |
| Register a file uploaded via pre-signed URL | POST /api/v1/storage/register-uploaded-file |
| Search files | POST /api/v1/storage/search-files |
| Update file metadata | POST /api/v1/storage/update-file-metadata |
| Upload a file (deprecated) | POST /api/v1/storage/upload-file |
| StorageManagerState | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-file-info.