Skip to content

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.

ParametersExpand Collapse
PartCreateParams params
Optional<String> uploadId
InputStream data

The chunk of bytes for this Part.

ReturnsExpand Collapse
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"upload.part"constant

The object type, which is always upload.part.

String uploadId

The ID of the Upload object that this Part was added to.

Add upload part

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(ByteArrayInputStream("some content".getBytes()))
            .build();
        UploadPart uploadPart = client.uploads().parts().create(params);
    }
}
{
  "id": "id",
  "created_at": 0,
  "object": "upload.part",
  "upload_id": "upload_id"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "object": "upload.part",
  "upload_id": "upload_id"
}