Files

interface Files

Files contain data for Responses, vector stores, batch requests, and fine-tuning.

Inheritors

Functions

Link copied to clipboard
abstract suspend fun delete(fileId: FileId, requestOptions: RequestOptions? = null): Boolean

Delete a file. Only owners of organizations can delete files currently.

Link copied to clipboard
abstract suspend fun download(fileId: FileId, requestOptions: RequestOptions? = null): ByteArray

Returns the contents of the specified fileId.

Link copied to clipboard
abstract suspend fun file(fileId: FileId, requestOptions: RequestOptions? = null): File?

Returns information about a specific file.

abstract suspend fun file(request: FileUpload, requestOptions: RequestOptions? = null): File

Upload a file that contains document(s) to be used across various endpoints/features.

Link copied to clipboard
abstract suspend fun files(requestOptions: RequestOptions? = null): List<File>

Returns a list of files that belong to the user's organization.

Link copied to clipboard
open suspend fun filesPage(after: FileId? = null, limit: Int? = null, order: SortOrder? = null, purpose: Purpose? = null, requestOptions: RequestOptions? = null): PaginatedList<FileResource>

Lists a page of files while preserving pagination cursors.

Link copied to clipboard
open suspend fun retrieveFile(fileId: FileId, requestOptions: RequestOptions? = null): FileResource?

Retrieves current file metadata, including its expiration timestamp.

Link copied to clipboard
open suspend fun uploadFile(request: FileUploadRequest, requestOptions: RequestOptions? = null): FileResource

Uploads a file with optional expiration and returns current response metadata.