Skip to main content

File object containing file identifier and URL for accessing the file resource

​
id
string

Unique identifier for the file

Example:

"file_0196b6e6-54e3-796d-9c6a-2862a5fef597"

​
name
string

Original filename

Example:

"4.jpg"

​
url
string<uri> | null

URL for accessing the file resource

Example:

"https://assets.bitgpt.xyz//app/public/src/storage/uploads/image/2025/05/09/0196b6e6-54e3-7290-9d73-0074c623e368.jpg"

​
mime_type
string

MIME type of the file

Example:

"image/jpeg"

​
type
enum<string>

Type of the file (e.g., image, document, video, audio, archive, general)

Available options:
image,
document,
video,
audio,
archive,
general
Example:

"image"

​
is_duplicate
boolean

Indicates if the file is a duplicate

Example:

true

​
hash
string

File hash for duplicate detection

Example:

"04b9e2ec43133ae7287f97764c0beda19f304374e1d6bfe4fcc36ad54502e5dc"

​
organization_id
string

Organization identifier that owns the file

Example:

"org_0196b0e9-11d8-7f26-b1d2-bd47054e4827"

​
original_name
string

Original filename as uploaded

Example:

"4.jpg"

​
filename
string

Generated filename for storage

Example:

"0198042e-6dde-76e0-b817-3afb324e29ac.jpg"

​
filepath
string

Full path to the file in storage

Example:

"org_uploads/org_0196b0e9-11d8-7f26-b1d2-bd47054e4827/image/0198042e-6dde-76e0-b817-3afb324e29ac.jpg"

​
file_size
integer

File size in bytes (alternative to size field)

Example:

1060793

​
created_at
string<mysql-date-time>

Timestamp when the file was created

Example:

"2025-07-13 16:26:48.415"

​
updated_at
string<mysql-date-time> | null

Timestamp when the file was last updated

Example:

null