Skip to main content
​
string | null
required
The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).Example: image/jpeg
​
string | null
required
The original filename of the uploaded file, including its file extension.Example: document.pdf
​
string
required
The unique identifier for the file.Example: file_xxxxxxxxxxxxx
​
string | null
required
The file size in bytes. Null if the file has not finished uploading.Example: 123.45
​
UploadStatuses
required
The current upload status of the file (e.g., pending, ready).Available options: pending, processing, ready, failed
​
string | null
required
The URL for accessing the file. For public files, this is a permanent CDN URL. For private files, this is a signed URL that expires. Null if the file has not finished uploading.
​
FileVisibility
required
Whether the file is publicly accessible or requires authentication.Available options: public, private