File Management

Download a file by ID

get

Downloads a file from the storage system using its unique identifier. The file is returned as a binary stream with appropriate content headers. This endpoint is typically used to retrieve files that were previously uploaded and associated with records through FileField columns in schemas.

Path parameters

fileIdstring · uuidRequired

Unique identifier (UUID) of the file to download

Example: d290f1ee-6c54-4b01-90e6-d701748f0851

Responses

200

File downloaded successfully - Returns the file as a binary stream

application/octet-stream

Responsestring · binary

400

Invalid file ID format - The provided ID is not a valid UUID

application/json

401

Unauthorized - Invalid or missing JWT token

application/octet-stream

404

File not found - No file exists with the provided ID

application/octet-stream

get

/api/file/download/{fileId}

HTTPcURLJavaScriptPython

GET /api/file/download/{fileId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

binary

Get storage usage information

get

Retrieves information about the file storage usage for the current workspace. Returns the maximum allowed storage capacity and the current amount of storage being used. Use this endpoint to monitor storage consumption and plan for capacity needs.

Responses

200

Storage information retrieved successfully

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

get

/api/file/storage-info

HTTPcURLJavaScriptPython

GET /api/file/storage-info HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "maxSize": 10737418240,
  "usedSize": 2147483648
}

Delete a file

delete

Permanently deletes a file from the storage system. This operation cannot be undone.

Important:

• The file will be removed from storage immediately

• Any references to this file in data records will become broken

• Consider updating or clearing FileField values that reference this file before deletion

Path parameters

fileIdstring · uuidRequired

Unique identifier (UUID) of the file to delete

Example: d290f1ee-6c54-4b01-90e6-d701748f0851

Responses

200

File deleted successfully

application/json

Responseany

400

Invalid file ID format - The provided ID is not a valid UUID

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

File not found - No file exists with the provided ID

application/json

delete

/api/file/delete/{fileId}

HTTPcURLJavaScriptPython

DELETE /api/file/delete/{fileId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

No content

Upload files

post

Uploads one or more files to the storage system. Each file must be associated with a unique identifier that will be used to reference it later (typically in a FileField column).

Request format: The request must be a multipart/form-data with paired id and file parts:

• id: The UUID to associate with the file (can be repeated for multiple files)

• file: The binary file content (can be repeated for multiple files)

The number of id parts must match the number of file parts exactly.

Example multipart request:

Content-Type: multipart/form-data; boundary=----WebKitFormBoundary

------WebKitFormBoundary
Content-Disposition: form-data; name="id"

d290f1ee-6c54-4b01-90e6-d701748f0851
------WebKitFormBoundary
Content-Disposition: form-data; name="file"; filename="document.pdf"
Content-Type: application/pdf

[binary file content]
------WebKitFormBoundary--

Body

multipart/form-data

objectOptional

Responses

200

Files uploaded successfully

application/json

Responseany

400

Mismatch between ID and file parts - The number of 'id' entries must match the number of 'file' entries

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

413

Payload too large - File exceeds maximum allowed size or storage quota exceeded

application/json

post

/api/file/upload

HTTPcURLJavaScriptPython

POST /api/file/upload HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 2

{}

No content