ai.z.openapi.api.file

Interface FileApi

public interface FileApi

File Management API for document and data handling Provides file upload, retrieval, deletion, and content access capabilities Supports various file formats for fine-tuning, knowledge base, and other AI tasks

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<FileDeleted>	deletedFile(String fileId) Delete a file from the platform Permanently removes the file and all associated data
retrofit2.Call<okhttp3.ResponseBody>	fileContent(String fileId) Download file content Streams the actual file content for download or processing
io.reactivex.rxjava3.core.Single<QueryFileResult>	queryFileList(String after, String purpose, String order, Integer limit) Query and list files with filtering options Retrieves a paginated list of files with optional filtering by purpose and ordering
io.reactivex.rxjava3.core.Single<File>	uploadFile(okhttp3.MultipartBody multipartBody) Upload a file to the platform Stores files for use in fine-tuning, knowledge base, or other AI operations

Method Detail

uploadFile

@POST(value="files")
io.reactivex.rxjava3.core.Single<File> uploadFile(@Body
                                                                       okhttp3.MultipartBody multipartBody)

Upload a file to the platform Stores files for use in fine-tuning, knowledge base, or other AI operations

Parameters:

multipartBody - File data with metadata including purpose and format

Returns:

File information including ID, name, size, and upload status

deletedFile

@DELETE(value="files/{file_id}")
io.reactivex.rxjava3.core.Single<FileDeleted> deletedFile(@Path(value="file_id")
                                                                                           String fileId)

Delete a file from the platform Permanently removes the file and all associated data

Parameters:

fileId - Unique identifier of the file to delete

Returns:

Confirmation of file deletion with status information

queryFileList

@GET(value="files")
io.reactivex.rxjava3.core.Single<QueryFileResult> queryFileList(@Query(value="after")
                                                                                    String after,
                                                                                    @Query(value="purpose")
                                                                                    String purpose,
                                                                                    @Query(value="order")
                                                                                    String order,
                                                                                    @Query(value="limit")
                                                                                    Integer limit)

Query and list files with filtering options Retrieves a paginated list of files with optional filtering by purpose and ordering

Parameters:

after - Cursor for pagination to get files after this point

purpose - Filter files by their intended purpose (e.g., fine-tune, assistants)

order - Sort order for the file list (e.g., created_at)

limit - Maximum number of files to return per page

Returns:

Paginated list of files with metadata

fileContent

@Streaming
 @GET(value="files/{file_id}/content")
retrofit2.Call<okhttp3.ResponseBody> fileContent(@Path(value="file_id")
                                                                                                   String fileId)

Download file content Streams the actual file content for download or processing

Parameters:

fileId - Unique identifier of the file to download

Returns:

Streaming file content in original format