Files

Upload File

client.files.upload(, ?): FileMetadata

POST/v1/files

List Files

client.files.list(?, ?): PageCursor<FileMetadata>

GET/v1/files

Download File

client.files.download(, ?): Response

GET/v1/files/{file_id}/content

Get File Metadata

client.files.retrieveMetadata(, ?): FileMetadata

GET/v1/files/{file_id}

Delete File

client.files.delete(, ?): DeletedFile

DELETE/v1/files/{file_id}

Models

DeletedFile { id, type }

id: string

ID of the deleted file.

type?: "file_deleted"

Deleted object type.

For file deletion, this is always "file_deleted".

defaultfile_deleted

FileMetadata { id, created_at, filename, 5 more }

id: string

Unique object identifier.

The format and length of IDs may change over time.

created_at: string

RFC 3339 datetime string representing when the file was created.

formatdate-time

filename: string

Original filename of the uploaded file.

maxLength500

minLength1

mime_type: string

MIME type of the file.

maxLength255

minLength1

size_bytes: number

Size of the file in bytes.

minimum0

type: "file"

Object type.

For files, this is always "file".

downloadable?: boolean

Whether the file can be downloaded.

defaultfalse

expires_at?: string | null

RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with expires_in_seconds, this is the upload time plus that value.

formatdate-time