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/subresources/parts/index.md +110 −0 created

1# Parts

3## Add upload part

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

7**post** `/uploads/{upload_id}/parts`

9Adds 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.

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

13It 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).

15### Parameters

17- `PartCreateParams params`

19 - `Optional<String> uploadId`

21 - `String data`

23 The chunk of bytes for this Part.

25### Returns

27- `class UploadPart:`

29 The upload Part represents a chunk of bytes we can add to an Upload object.

31 - `String id`

33 The upload Part unique identifier, which can be referenced in API endpoints.

35 - `long createdAt`

37 The Unix timestamp (in seconds) for when the Part was created.

39 - `JsonValue; object_ "upload.part"constant`

41 The object type, which is always `upload.part`.

43 - `UPLOAD_PART("upload.part")`

45 - `String uploadId`

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

49### Example

51```java

52package com.openai.example;

54import com.openai.client.OpenAIClient;

55import com.openai.client.okhttp.OpenAIOkHttpClient;

56import com.openai.models.uploads.parts.PartCreateParams;

57import com.openai.models.uploads.parts.UploadPart;

58import java.io.ByteArrayInputStream;

60public final class Main {

61 private Main() {}

63 public static void main(String[] args) {

64 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

66 PartCreateParams params = PartCreateParams.builder()

67 .uploadId("upload_abc123")

68 .data(new ByteArrayInputStream("Example data".getBytes()))

69 .build();

70 UploadPart uploadPart = client.uploads().parts().create(params);

71 }

72}

73```

75#### Response

77```json

78{

79 "id": "id",

80 "created_at": 0,

81 "object": "upload.part",

82 "upload_id": "upload_id"

83}

84```

86## Domain Types

88### Upload Part

90- `class UploadPart:`

92 The upload Part represents a chunk of bytes we can add to an Upload object.

94 - `String id`

96 The upload Part unique identifier, which can be referenced in API endpoints.

98 - `long createdAt`

100 The Unix timestamp (in seconds) for when the Part was created.

101

102 - `JsonValue; object_ "upload.part"constant`

103

104 The object type, which is always `upload.part`.

105

106 - `UPLOAD_PART("upload.part")`

107

108 - `String uploadId`

109

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