Skip to content
API Reference
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.

ParametersExpand Collapse
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"created_at"constant

Anchor timestamp after which the expiration policy applies. Supported anchors: 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).

minimum3600
maximum2592000
ReturnsExpand Collapse
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"upload"constant

The object type, which is always "upload".

String purpose

The intended purpose of the file. Please refer here for acceptable values.

Status status

The status of the Upload.

Accepts one of the following:
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"file"constant

The object type, which is always 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.

Accepts one of the following:
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")
DeprecatedStatus status

Deprecated. The current status of the file, which can be either uploaded, processed, or error.

Accepts one of the following:
UPLOADED("uploaded")
PROCESSED("processed")
ERROR("error")
Optional<Long> expiresAt

The Unix timestamp (in seconds) for when the file will expire.

DeprecatedOptional<String> statusDetails

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Create upload

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);
    }
}
{
  "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"
  }
}
Returns Examples
{
  "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"
  }
}