Uploads

interface Uploads

Upload files in parts, then assemble them into a regular file. Default methods throw UnsupportedOperationException so custom OpenAI implementations remain source compatible. Clients created by the SDK implement all operations.

Inheritors

Functions

Link copied to clipboard
open suspend fun cancelUpload(id: UploadId, requestOptions: RequestOptions? = null): Upload

Cancels an upload. Server errors, including invalid lifecycle transitions, propagate.

Link copied to clipboard
open suspend fun completeUpload(id: UploadId, request: UploadCompletionRequest, requestOptions: RequestOptions? = null): Upload

Assembles the declared part IDs in their supplied order and returns the resulting file.

Link copied to clipboard
open suspend fun upload(request: UploadRequest, requestOptions: RequestOptions? = null): Upload

Creates an upload with its expected total length and resulting file's expiration policy.

Link copied to clipboard
open suspend fun uploadPart(id: UploadId, data: FileSource, requestOptions: RequestOptions? = null): UploadPart

Uploads one part. Consumes and closes data's source; use a new source for every call. Parts may be uploaded concurrently; their final order is chosen by completeUpload.