Parts

Add upload part

$ openai uploads:parts create

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

--upload-id: string

The ID of the Upload.
--data: string

The chunk of bytes for this Part.

Returns

upload_part: object { id, created_at, object, upload_id }

The upload Part represents a chunk of bytes we can add to an Upload object.
- id: string
  
  The upload Part unique identifier, which can be referenced in API endpoints.
- created_at: number
  
  The Unix timestamp (in seconds) for when the Part was created.
- object: "upload.part"
  
  The object type, which is always upload.part.
- upload_id: string
  
  The ID of the Upload object that this Part was added to.

Example

openai uploads:parts create \
  --api-key 'My API Key' \
  --upload-id upload_abc123 \
  --data 'Example data'

Response

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

Domain Types

Upload Part

upload_part: object { id, created_at, object, upload_id }

The upload Part represents a chunk of bytes we can add to an Upload object.
- id: string
  
  The upload Part unique identifier, which can be referenced in API endpoints.
- created_at: number
  
  The Unix timestamp (in seconds) for when the Part was created.
- object: "upload.part"
  
  The object type, which is always upload.part.
- upload_id: string
  
  The ID of the Upload object that this Part was added to.

cli/resources/uploads/subresources/parts/index.md +89 −0 created

1# Parts

3## Add upload part

5`$ openai uploads:parts create`

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- `--upload-id: string`

19 The ID of the Upload.

21- `--data: string`

23 The chunk of bytes for this Part.

25### Returns

27- `upload_part: object { id, created_at, object, upload_id }`

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

31 - `id: string`

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

35 - `created_at: number`

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

39 - `object: "upload.part"`

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

43 - `upload_id: string`

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

47### Example

49```cli

50openai uploads:parts create \

51 --api-key 'My API Key' \

52 --upload-id upload_abc123 \

53 --data 'Example data'

54```

56#### Response

58```json

59{

60 "id": "id",

61 "created_at": 0,

62 "object": "upload.part",

63 "upload_id": "upload_id"

64}

65```

67## Domain Types

69### Upload Part

71- `upload_part: object { id, created_at, object, upload_id }`

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

75 - `id: string`

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

79 - `created_at: number`

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

83 - `object: "upload.part"`

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

87 - `upload_id: string`

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