FilesAPI extension

Methods

addUploadPart({required String uploadId, required Uint8List data}) → Future<UploadPart>

Available on OpenAIClient, provided by the FilesAPI extension

Add a part (<= 64 MB) to an Upload.

cancelUpload(String uploadId) → Future<Upload>

Available on OpenAIClient, provided by the FilesAPI extension

Cancel an Upload. No further parts may be added after cancellation.

completeUpload({required String uploadId, required List<String> partIds, String? md5}) → Future<Upload>

Available on OpenAIClient, provided by the FilesAPI extension

Complete an Upload by specifying the ordered list of part IDs. Optionally pass an MD5 checksum of the entire file to verify integrity.

createUpload({required int bytes, required String filename, required String mimeType, required FilePurpose purpose, FileExpiresAfter? expiresAfter}) → Future<Upload>

Available on OpenAIClient, provided by the FilesAPI extension

Create an Upload session for large files (multipart).

deleteFile(String fileId) → Future<DeletionStatus>

Available on OpenAIClient, provided by the FilesAPI extension

Delete a file. Returns deletion status: {id, object:"file", deleted:true}

listFiles({String? after, int? limit, SortOrder? order, String? purpose}) → Future<OpenAIFileList>

Available on OpenAIClient, provided by the FilesAPI extension

List files (optionally filter by purpose, paginate, and order).

retrieveFile(String fileId) → Future<OpenAIFile>

Available on OpenAIClient, provided by the FilesAPI extension

Retrieve a single file’s metadata.

retrieveFileContent(String fileId) → Future<Uint8List>

Available on OpenAIClient, provided by the FilesAPI extension

Download file contents as bytes. Caller can persist them as needed.

uploadFileBytes({required FilePurpose purpose, required Uint8List fileBytes, required String filename, FileExpiresAfter? expiresAfter, String? mimeType}) → Future<OpenAIFile>

Available on OpenAIClient, provided by the FilesAPI extension

Upload a file from raw bytes.