Files

Upload File

FileMetadata files().upload(params, requestOptions = RequestOptions.none())

POST/v1/files

List Files

FileListPage files().list(params = FileListParams.none(), requestOptions = RequestOptions.none())

GET/v1/files

Download File

HttpResponse files().download(params = FileDownloadParams.none(), requestOptions = RequestOptions.none())

GET/v1/files/{file_id}/content

Get File Metadata

FileMetadata files().retrieveMetadata(params = FileRetrieveMetadataParams.none(), requestOptions = RequestOptions.none())

GET/v1/files/{file_id}

Delete File

DeletedFile files().delete(params = FileDeleteParams.none(), requestOptions = RequestOptions.none())

DELETE/v1/files/{file_id}

Models

class DeletedFile { type; id; }

Optional<Type> type

Deleted object type.

For file deletion, this is always "file_deleted".

String id

ID of the deleted file.

class FileMetadata { type = "file"; id; createdAt; /* 5 more */ }

JsonValue type = "file"

Object type.

For files, this is always "file".

String id

Unique object identifier.

The format and length of IDs may change over time.

LocalDateTime createdAt

RFC 3339 datetime string representing when the file was created.

formatdate-time

String filename

Original filename of the uploaded file.

minLength1

maxLength500

String mimeType

MIME type of the file.

minLength1

maxLength255

long sizeBytes

Size of the file in bytes.

minimum0

Optional<Boolean> downloadable

Whether the file can be downloaded.

Optional<LocalDateTime> expiresAt

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