Uploads

Create upload

Upload uploads().create(UploadCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /uploads

Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.

For certain purpose values, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case.

For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.

Returns the Upload object with status pending.

Parameters

UploadCreateParams params
- long bytes
  
  The number of bytes in the file you are uploading.
- String filename
  
  The name of the file to upload.
- String mimeType
  
  The MIME type of the file.
  
  This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.
- FilePurpose purpose
  
  The intended purpose of the uploaded file.
  
  See the documentation on File purposes.
- Optional<ExpiresAfter> expiresAfter
  
  The expiration policy for a file. By default, files with purpose=batch expire after 30 days and all other files are persisted until they are manually deleted.
  - JsonValue; anchor "created_at"constant
    
    Anchor timestamp after which the expiration policy applies. Supported anchors: created_at.
    - CREATED_AT("created_at")
  - long seconds
    
    The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).

Returns

class Upload:

The Upload object can accept byte chunks in the form of Parts.
- String id
  
  The Upload unique identifier, which can be referenced in API endpoints.
- long bytes
  
  The intended number of bytes to be uploaded.
- long createdAt
  
  The Unix timestamp (in seconds) for when the Upload was created.
- long expiresAt
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- String filename
  
  The name of the file to be uploaded.
- JsonValue; object_ "upload"constant
  
  The object type, which is always "upload".
  - UPLOAD("upload")
- String purpose
  
  The intended purpose of the file. Please refer here for acceptable values.
- Status status
  
  The status of the Upload.
  - PENDING("pending")
  - COMPLETED("completed")
  - CANCELLED("cancelled")
  - EXPIRED("expired")
- Optional<FileObject> file
  
  The File object represents a document that has been uploaded to OpenAI.
  - String id
    
    The file identifier, which can be referenced in the API endpoints.
  - long bytes
    
    The size of the file, in bytes.
  - long createdAt
    
    The Unix timestamp (in seconds) for when the file was created.
  - String filename
    
    The name of the file.
  - JsonValue; object_ "file"constant
    
    The object type, which is always file.
    - FILE("file")
  - Purpose purpose
    
    The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
    - ASSISTANTS("assistants")
    - ASSISTANTS_OUTPUT("assistants_output")
    - BATCH("batch")
    - BATCH_OUTPUT("batch_output")
    - FINE_TUNE("fine-tune")
    - FINE_TUNE_RESULTS("fine-tune-results")
    - VISION("vision")
    - USER_DATA("user_data")
  - Status status
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - UPLOADED("uploaded")
    - PROCESSED("processed")
    - ERROR("error")
  - Optional<Long> expiresAt
    
    The Unix timestamp (in seconds) for when the file will expire.
  - Optional<String> statusDetails
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.files.FilePurpose;
import com.openai.models.uploads.Upload;
import com.openai.models.uploads.UploadCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        UploadCreateParams params = UploadCreateParams.builder()
            .bytes(0L)
            .filename("filename")
            .mimeType("mime_type")
            .purpose(FilePurpose.ASSISTANTS)
            .build();
        Upload upload = client.uploads().create(params);
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "object": "upload",
  "purpose": "purpose",
  "status": "pending",
  "file": {
    "id": "id",
    "bytes": 0,
    "created_at": 0,
    "filename": "filename",
    "object": "file",
    "purpose": "assistants",
    "status": "uploaded",
    "expires_at": 0,
    "status_details": "status_details"
  }
}

Complete upload

Upload uploads().complete(UploadCompleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /uploads/{upload_id}/complete

Completes the Upload.

Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.

You can specify the order of the Parts by passing in an ordered list of the Part IDs.

The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. Returns the Upload object with status completed, including an additional file property containing the created usable File object.

Parameters

UploadCompleteParams params
- Optional<String> uploadId
- List<String> partIds
  
  The ordered list of Part IDs.
- Optional<String> md5
  
  The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.

Returns

class Upload:

The Upload object can accept byte chunks in the form of Parts.
- String id
  
  The Upload unique identifier, which can be referenced in API endpoints.
- long bytes
  
  The intended number of bytes to be uploaded.
- long createdAt
  
  The Unix timestamp (in seconds) for when the Upload was created.
- long expiresAt
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- String filename
  
  The name of the file to be uploaded.
- JsonValue; object_ "upload"constant
  
  The object type, which is always "upload".
  - UPLOAD("upload")
- String purpose
  
  The intended purpose of the file. Please refer here for acceptable values.
- Status status
  
  The status of the Upload.
  - PENDING("pending")
  - COMPLETED("completed")
  - CANCELLED("cancelled")
  - EXPIRED("expired")
- Optional<FileObject> file
  
  The File object represents a document that has been uploaded to OpenAI.
  - String id
    
    The file identifier, which can be referenced in the API endpoints.
  - long bytes
    
    The size of the file, in bytes.
  - long createdAt
    
    The Unix timestamp (in seconds) for when the file was created.
  - String filename
    
    The name of the file.
  - JsonValue; object_ "file"constant
    
    The object type, which is always file.
    - FILE("file")
  - Purpose purpose
    
    The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
    - ASSISTANTS("assistants")
    - ASSISTANTS_OUTPUT("assistants_output")
    - BATCH("batch")
    - BATCH_OUTPUT("batch_output")
    - FINE_TUNE("fine-tune")
    - FINE_TUNE_RESULTS("fine-tune-results")
    - VISION("vision")
    - USER_DATA("user_data")
  - Status status
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - UPLOADED("uploaded")
    - PROCESSED("processed")
    - ERROR("error")
  - Optional<Long> expiresAt
    
    The Unix timestamp (in seconds) for when the file will expire.
  - Optional<String> statusDetails
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.uploads.Upload;
import com.openai.models.uploads.UploadCompleteParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        UploadCompleteParams params = UploadCompleteParams.builder()
            .uploadId("upload_abc123")
            .addPartId("string")
            .build();
        Upload upload = client.uploads().complete(params);
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "object": "upload",
  "purpose": "purpose",
  "status": "pending",
  "file": {
    "id": "id",
    "bytes": 0,
    "created_at": 0,
    "filename": "filename",
    "object": "file",
    "purpose": "assistants",
    "status": "uploaded",
    "expires_at": 0,
    "status_details": "status_details"
  }
}

Cancel upload

Upload uploads().cancel(UploadCancelParamsparams = UploadCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post /uploads/{upload_id}/cancel

Cancels the Upload. No Parts may be added after an Upload is cancelled.

Returns the Upload object with status cancelled.

Parameters

UploadCancelParams params
- Optional<String> uploadId

Returns

class Upload:

The Upload object can accept byte chunks in the form of Parts.
- String id
  
  The Upload unique identifier, which can be referenced in API endpoints.
- long bytes
  
  The intended number of bytes to be uploaded.
- long createdAt
  
  The Unix timestamp (in seconds) for when the Upload was created.
- long expiresAt
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- String filename
  
  The name of the file to be uploaded.
- JsonValue; object_ "upload"constant
  
  The object type, which is always "upload".
  - UPLOAD("upload")
- String purpose
  
  The intended purpose of the file. Please refer here for acceptable values.
- Status status
  
  The status of the Upload.
  - PENDING("pending")
  - COMPLETED("completed")
  - CANCELLED("cancelled")
  - EXPIRED("expired")
- Optional<FileObject> file
  
  The File object represents a document that has been uploaded to OpenAI.
  - String id
    
    The file identifier, which can be referenced in the API endpoints.
  - long bytes
    
    The size of the file, in bytes.
  - long createdAt
    
    The Unix timestamp (in seconds) for when the file was created.
  - String filename
    
    The name of the file.
  - JsonValue; object_ "file"constant
    
    The object type, which is always file.
    - FILE("file")
  - Purpose purpose
    
    The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
    - ASSISTANTS("assistants")
    - ASSISTANTS_OUTPUT("assistants_output")
    - BATCH("batch")
    - BATCH_OUTPUT("batch_output")
    - FINE_TUNE("fine-tune")
    - FINE_TUNE_RESULTS("fine-tune-results")
    - VISION("vision")
    - USER_DATA("user_data")
  - Status status
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - UPLOADED("uploaded")
    - PROCESSED("processed")
    - ERROR("error")
  - Optional<Long> expiresAt
    
    The Unix timestamp (in seconds) for when the file will expire.
  - Optional<String> statusDetails
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.uploads.Upload;
import com.openai.models.uploads.UploadCancelParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        Upload upload = client.uploads().cancel("upload_abc123");
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "object": "upload",
  "purpose": "purpose",
  "status": "pending",
  "file": {
    "id": "id",
    "bytes": 0,
    "created_at": 0,
    "filename": "filename",
    "object": "file",
    "purpose": "assistants",
    "status": "uploaded",
    "expires_at": 0,
    "status_details": "status_details"
  }
}

Domain Types

Upload

class Upload:

The Upload object can accept byte chunks in the form of Parts.
- String id
  
  The Upload unique identifier, which can be referenced in API endpoints.
- long bytes
  
  The intended number of bytes to be uploaded.
- long createdAt
  
  The Unix timestamp (in seconds) for when the Upload was created.
- long expiresAt
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- String filename
  
  The name of the file to be uploaded.
- JsonValue; object_ "upload"constant
  
  The object type, which is always "upload".
  - UPLOAD("upload")
- String purpose
  
  The intended purpose of the file. Please refer here for acceptable values.
- Status status
  
  The status of the Upload.
  - PENDING("pending")
  - COMPLETED("completed")
  - CANCELLED("cancelled")
  - EXPIRED("expired")
- Optional<FileObject> file
  
  The File object represents a document that has been uploaded to OpenAI.
  - String id
    
    The file identifier, which can be referenced in the API endpoints.
  - long bytes
    
    The size of the file, in bytes.
  - long createdAt
    
    The Unix timestamp (in seconds) for when the file was created.
  - String filename
    
    The name of the file.
  - JsonValue; object_ "file"constant
    
    The object type, which is always file.
    - FILE("file")
  - Purpose purpose
    
    The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
    - ASSISTANTS("assistants")
    - ASSISTANTS_OUTPUT("assistants_output")
    - BATCH("batch")
    - BATCH_OUTPUT("batch_output")
    - FINE_TUNE("fine-tune")
    - FINE_TUNE_RESULTS("fine-tune-results")
    - VISION("vision")
    - USER_DATA("user_data")
  - Status status
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - UPLOADED("uploaded")
    - PROCESSED("processed")
    - ERROR("error")
  - Optional<Long> expiresAt
    
    The Unix timestamp (in seconds) for when the file will expire.
  - Optional<String> statusDetails
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Parts

Add upload part

UploadPart uploads().parts().create(PartCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /uploads/{upload_id}/parts

Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload.

Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.

It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload.

Parameters

PartCreateParams params
- Optional<String> uploadId
- String data
  
  The chunk of bytes for this Part.

Returns

class UploadPart:

The upload Part represents a chunk of bytes we can add to an Upload object.
- String id
  
  The upload Part unique identifier, which can be referenced in API endpoints.
- long createdAt
  
  The Unix timestamp (in seconds) for when the Part was created.
- JsonValue; object_ "upload.part"constant
  
  The object type, which is always upload.part.
  - UPLOAD_PART("upload.part")
- String uploadId
  
  The ID of the Upload object that this Part was added to.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.uploads.parts.PartCreateParams;
import com.openai.models.uploads.parts.UploadPart;
import java.io.ByteArrayInputStream;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        PartCreateParams params = PartCreateParams.builder()
            .uploadId("upload_abc123")
            .data(new ByteArrayInputStream("Example data".getBytes()))
            .build();
        UploadPart uploadPart = client.uploads().parts().create(params);
    }
}

Response

{
  "id": "id",
  "created_at": 0,
  "object": "upload.part",
  "upload_id": "upload_id"
}

Domain Types

Upload Part

class UploadPart:

The upload Part represents a chunk of bytes we can add to an Upload object.
- String id
  
  The upload Part unique identifier, which can be referenced in API endpoints.
- long createdAt
  
  The Unix timestamp (in seconds) for when the Part was created.
- JsonValue; object_ "upload.part"constant
  
  The object type, which is always upload.part.
  - UPLOAD_PART("upload.part")
- String uploadId
  
  The ID of the Upload object that this Part was added to.

java/resources/uploads/index.md +37 −6

6 6

7**post** `/uploads`7**post** `/uploads`

8 8

~~9Create upload~~9Creates an intermediate [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object

10that you can add [Parts](https://platform.openai.com/docs/api-reference/uploads/part-object) to.

11Currently, an Upload can accept at most 8 GB in total and expires after an

12hour after you create it.

14Once you complete the Upload, we will create a

15[File](https://platform.openai.com/docs/api-reference/files/object) object that contains all the parts

16you uploaded. This File is usable in the rest of our platform as a regular

17File object.

19For certain `purpose` values, the correct `mime_type` must be specified.

20Please refer to documentation for the

21[supported MIME types for your use case](https://platform.openai.com/docs/assistants/tools/file-search#supported-files).

23For guidance on the proper filename extensions for each purpose, please

24follow the documentation on [creating a

25File](https://platform.openai.com/docs/api-reference/files/create).

27Returns the Upload object with status `pending`.

10 28

11### Parameters29### Parameters

12 30

27 This must fall within the supported MIME types for your file purpose. See45 This must fall within the supported MIME types for your file purpose. See

28 the supported MIME types for assistants and vision.46 the supported MIME types for assistants and vision.

29 47

~~30 - `JsonValue purpose`~~48 - `FilePurpose purpose`

31 49

32 The intended purpose of the uploaded file.50 The intended purpose of the uploaded file.

33 51

181 .bytes(0L)199 .bytes(0L)

182 .filename("filename")200 .filename("filename")

183 .mimeType("mime_type")201 .mimeType("mime_type")

184 .purpose(FilePurpose.builder().build())202 .purpose(FilePurpose.ASSISTANTS)

185 .build();203 .build();

186 Upload upload = client.uploads().create(params);204 Upload upload = client.uploads().create(params);

187 }205 }

220 238

221**post** `/uploads/{upload_id}/complete`239**post** `/uploads/{upload_id}/complete`

222 240

223Complete upload241Completes the [Upload](https://platform.openai.com/docs/api-reference/uploads/object).

242

243Within the returned Upload object, there is a nested [File](https://platform.openai.com/docs/api-reference/files/object) object that is ready to use in the rest of the platform.

244

245You can specify the order of the Parts by passing in an ordered list of the Part IDs.

246

247The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.

248Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object.

224 249

225### Parameters250### Parameters

226 251

405 430

406**post** `/uploads/{upload_id}/cancel`431**post** `/uploads/{upload_id}/cancel`

407 432

408Cancel upload433Cancels the Upload. No Parts may be added after an Upload is cancelled.

434

435Returns the Upload object with status `cancelled`.

409 436

410### Parameters437### Parameters

411 438

694 721

695**post** `/uploads/{upload_id}/parts`722**post** `/uploads/{upload_id}/parts`

696 723

697Add upload part724Adds a [Part](https://platform.openai.com/docs/api-reference/uploads/part-object) to an [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload.

725

726Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.

727

728It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](https://platform.openai.com/docs/api-reference/uploads/complete).

698 729

699### Parameters730### Parameters

700 731

java/resources/uploads/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

Uploads

Create upload

Parameters

Returns

Example

Response

Complete upload

Parameters

Returns

Example

Response

Cancel upload

Parameters

Returns

Example

Response

Domain Types

Upload

Parts

Add upload part

Parameters

Returns

Example

Response

Domain Types

Upload Part