Skip to content
LlamaIndex API Docs
Framework Docs
API Reference

Files

Upload File
FileCreateResponse files().create(FileCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/beta/files
Query Files
Deprecated
FileQueryResponse files().query(FileQueryParamsparams = FileQueryParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/beta/files/query
List Files
FileListPage files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/beta/files
Delete File
files().delete(FileDeleteParamsparams = FileDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/api/v1/beta/files/{file_id}
Read File Content
PresignedUrl files().get(FileGetParamsparams = FileGetParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/beta/files/{file_id}/content
ModelsExpand Collapse
class File:

Schema for a file.

String id

Unique identifier

formatuuid
String name
String projectId

The ID of the project that the file belongs to

formatuuid
Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time
Optional<String> dataSourceId

The ID of the data source that the file belongs to

formatuuid
Optional<LocalDateTime> expiresAt

The expiration date for the file. Files past this date can be deleted.

formatdate-time
Optional<String> externalFileId

The ID of the file in the external system

Optional<Long> fileSize

Size of the file in bytes

minimum0
Optional<String> fileType

File type (e.g. pdf, docx, etc.)

maxLength3000
minLength1
Optional<LocalDateTime> lastModifiedAt

The last modified time of the file

formatdate-time
Optional<PermissionInfo> permissionInfo

Permission information for the file

One of the following:
class UnionMember0:
List<JsonValue>
String
double
boolean
Optional<String> purpose

The intended purpose of the file (e.g., ‘user_data’, ‘parse’, ‘extract’, ‘split’, ‘classify’)

Optional<ResourceInfo> resourceInfo

Resource information for the file

One of the following:
class UnionMember0:
List<JsonValue>
String
double
boolean
Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time
class PresignedUrl:

Schema for a presigned URL.

LocalDateTime expiresAt

The time at which the presigned URL expires

formatdate-time
String url

A presigned URL for IO operations against a private file

minLength1
formaturi
Optional<FormFields> formFields

Form fields for a presigned POST request