Uploads

Create upload

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

post /uploads

Create upload

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.
- JsonValue 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.builder().build())
            .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

Complete upload

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

Cancel upload

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

Add upload part

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 +794 −0 created

1# Uploads

3## Create upload

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

7**post** `/uploads`

9Create upload

11### Parameters

13- `UploadCreateParams params`

15 - `long bytes`

17 The number of bytes in the file you are uploading.

19 - `String filename`

21 The name of the file to upload.

23 - `String mimeType`

25 The MIME type of the file.

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

28 the supported MIME types for assistants and vision.

30 - `JsonValue purpose`

32 The intended purpose of the uploaded file.

34 See the [documentation on File

35 purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose).

37 - `Optional<ExpiresAfter> expiresAfter`

39 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.

41 - `JsonValue; anchor "created_at"constant`

43 Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`.

45 - `CREATED_AT("created_at")`

47 - `long seconds`

49 The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).

51### Returns

53- `class Upload:`

55 The Upload object can accept byte chunks in the form of Parts.

57 - `String id`

59 The Upload unique identifier, which can be referenced in API endpoints.

61 - `long bytes`

63 The intended number of bytes to be uploaded.

65 - `long createdAt`

67 The Unix timestamp (in seconds) for when the Upload was created.

69 - `long expiresAt`

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

73 - `String filename`

75 The name of the file to be uploaded.

77 - `JsonValue; object_ "upload"constant`

79 The object type, which is always "upload".

81 - `UPLOAD("upload")`

83 - `String purpose`

85 The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values.

87 - `Status status`

89 The status of the Upload.

91 - `PENDING("pending")`

93 - `COMPLETED("completed")`

95 - `CANCELLED("cancelled")`

97 - `EXPIRED("expired")`

99 - `Optional<FileObject> file`

100

101 The `File` object represents a document that has been uploaded to OpenAI.

102

103 - `String id`

104

105 The file identifier, which can be referenced in the API endpoints.

106

107 - `long bytes`

108

109 The size of the file, in bytes.

110

111 - `long createdAt`

112

113 The Unix timestamp (in seconds) for when the file was created.

114

115 - `String filename`

116

117 The name of the file.

118

119 - `JsonValue; object_ "file"constant`

120

121 The object type, which is always `file`.

122

123 - `FILE("file")`

124

125 - `Purpose purpose`

126

127 The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`.

128

129 - `ASSISTANTS("assistants")`

130

131 - `ASSISTANTS_OUTPUT("assistants_output")`

132

133 - `BATCH("batch")`

134

135 - `BATCH_OUTPUT("batch_output")`

136

137 - `FINE_TUNE("fine-tune")`

138

139 - `FINE_TUNE_RESULTS("fine-tune-results")`

140

141 - `VISION("vision")`

142

143 - `USER_DATA("user_data")`

144

145 - `Status status`

146

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

148

149 - `UPLOADED("uploaded")`

150

151 - `PROCESSED("processed")`

152

153 - `ERROR("error")`

154

155 - `Optional<Long> expiresAt`

156

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

158

159 - `Optional<String> statusDetails`

160

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

162

163### Example

164

165```java

166package com.openai.example;

167

168import com.openai.client.OpenAIClient;

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

170import com.openai.models.files.FilePurpose;

171import com.openai.models.uploads.Upload;

172import com.openai.models.uploads.UploadCreateParams;

173

174public final class Main {

175 private Main() {}

176

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

178 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

179

180 UploadCreateParams params = UploadCreateParams.builder()

181 .bytes(0L)

182 .filename("filename")

183 .mimeType("mime_type")

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

185 .build();

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

187 }

188}

189```

190

191#### Response

192

193```json

194{

195 "id": "id",

196 "bytes": 0,

197 "created_at": 0,

198 "expires_at": 0,

199 "filename": "filename",

200 "object": "upload",

201 "purpose": "purpose",

202 "status": "pending",

203 "file": {

204 "id": "id",

205 "bytes": 0,

206 "created_at": 0,

207 "filename": "filename",

208 "object": "file",

209 "purpose": "assistants",

210 "status": "uploaded",

211 "expires_at": 0,

212 "status_details": "status_details"

213 }

214}

215```

216

217## Complete upload

218

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

220

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

222

223Complete upload

224

225### Parameters

226

227- `UploadCompleteParams params`

228

229 - `Optional<String> uploadId`

230

231 - `List<String> partIds`

232

233 The ordered list of Part IDs.

234

235 - `Optional<String> md5`

236

237 The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.

238

239### Returns

240

241- `class Upload:`

242

243 The Upload object can accept byte chunks in the form of Parts.

244

245 - `String id`

246

247 The Upload unique identifier, which can be referenced in API endpoints.

248

249 - `long bytes`

250

251 The intended number of bytes to be uploaded.

252

253 - `long createdAt`

254

255 The Unix timestamp (in seconds) for when the Upload was created.

256

257 - `long expiresAt`

258

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

260

261 - `String filename`

262

263 The name of the file to be uploaded.

264

265 - `JsonValue; object_ "upload"constant`

266

267 The object type, which is always "upload".

268

269 - `UPLOAD("upload")`

270

271 - `String purpose`

272

273 The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values.

274

275 - `Status status`

276

277 The status of the Upload.

278

279 - `PENDING("pending")`

280

281 - `COMPLETED("completed")`

282

283 - `CANCELLED("cancelled")`

284

285 - `EXPIRED("expired")`

286

287 - `Optional<FileObject> file`

288

289 The `File` object represents a document that has been uploaded to OpenAI.

290

291 - `String id`

292

293 The file identifier, which can be referenced in the API endpoints.

294

295 - `long bytes`

296

297 The size of the file, in bytes.

298

299 - `long createdAt`

300

301 The Unix timestamp (in seconds) for when the file was created.

302

303 - `String filename`

304

305 The name of the file.

306

307 - `JsonValue; object_ "file"constant`

308

309 The object type, which is always `file`.

310

311 - `FILE("file")`

312

313 - `Purpose purpose`

314

315 The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`.

316

317 - `ASSISTANTS("assistants")`

318

319 - `ASSISTANTS_OUTPUT("assistants_output")`

320

321 - `BATCH("batch")`

322

323 - `BATCH_OUTPUT("batch_output")`

324

325 - `FINE_TUNE("fine-tune")`

326

327 - `FINE_TUNE_RESULTS("fine-tune-results")`

328

329 - `VISION("vision")`

330

331 - `USER_DATA("user_data")`

332

333 - `Status status`

334

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

336

337 - `UPLOADED("uploaded")`

338

339 - `PROCESSED("processed")`

340

341 - `ERROR("error")`

342

343 - `Optional<Long> expiresAt`

344

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

346

347 - `Optional<String> statusDetails`

348

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

350

351### Example

352

353```java

354package com.openai.example;

355

356import com.openai.client.OpenAIClient;

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

358import com.openai.models.uploads.Upload;

359import com.openai.models.uploads.UploadCompleteParams;

360

361public final class Main {

362 private Main() {}

363

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

365 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

366

367 UploadCompleteParams params = UploadCompleteParams.builder()

368 .uploadId("upload_abc123")

369 .addPartId("string")

370 .build();

371 Upload upload = client.uploads().complete(params);

372 }

373}

374```

375

376#### Response

377

378```json

379{

380 "id": "id",

381 "bytes": 0,

382 "created_at": 0,

383 "expires_at": 0,

384 "filename": "filename",

385 "object": "upload",

386 "purpose": "purpose",

387 "status": "pending",

388 "file": {

389 "id": "id",

390 "bytes": 0,

391 "created_at": 0,

392 "filename": "filename",

393 "object": "file",

394 "purpose": "assistants",

395 "status": "uploaded",

396 "expires_at": 0,

397 "status_details": "status_details"

398 }

399}

400```

401

402## Cancel upload

403

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

405

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

407

408Cancel upload

409

410### Parameters

411

412- `UploadCancelParams params`

413

414 - `Optional<String> uploadId`

415

416### Returns

417

418- `class Upload:`

419

420 The Upload object can accept byte chunks in the form of Parts.

421

422 - `String id`

423

424 The Upload unique identifier, which can be referenced in API endpoints.

425

426 - `long bytes`

427

428 The intended number of bytes to be uploaded.

429

430 - `long createdAt`

431

432 The Unix timestamp (in seconds) for when the Upload was created.

433

434 - `long expiresAt`

435

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

437

438 - `String filename`

439

440 The name of the file to be uploaded.

441

442 - `JsonValue; object_ "upload"constant`

443

444 The object type, which is always "upload".

445

446 - `UPLOAD("upload")`

447

448 - `String purpose`

449

450 The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values.

451

452 - `Status status`

453

454 The status of the Upload.

455

456 - `PENDING("pending")`

457

458 - `COMPLETED("completed")`

459

460 - `CANCELLED("cancelled")`

461

462 - `EXPIRED("expired")`

463

464 - `Optional<FileObject> file`

465

466 The `File` object represents a document that has been uploaded to OpenAI.

467

468 - `String id`

469

470 The file identifier, which can be referenced in the API endpoints.

471

472 - `long bytes`

473

474 The size of the file, in bytes.

475

476 - `long createdAt`

477

478 The Unix timestamp (in seconds) for when the file was created.

479

480 - `String filename`

481

482 The name of the file.

483

484 - `JsonValue; object_ "file"constant`

485

486 The object type, which is always `file`.

487

488 - `FILE("file")`

489

490 - `Purpose purpose`

491

492 The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`.

493

494 - `ASSISTANTS("assistants")`

495

496 - `ASSISTANTS_OUTPUT("assistants_output")`

497

498 - `BATCH("batch")`

499

500 - `BATCH_OUTPUT("batch_output")`

501

502 - `FINE_TUNE("fine-tune")`

503

504 - `FINE_TUNE_RESULTS("fine-tune-results")`

505

506 - `VISION("vision")`

507

508 - `USER_DATA("user_data")`

509

510 - `Status status`

511

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

513

514 - `UPLOADED("uploaded")`

515

516 - `PROCESSED("processed")`

517

518 - `ERROR("error")`

519

520 - `Optional<Long> expiresAt`

521

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

523

524 - `Optional<String> statusDetails`

525

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

527

528### Example

529

530```java

531package com.openai.example;

532

533import com.openai.client.OpenAIClient;

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

535import com.openai.models.uploads.Upload;

536import com.openai.models.uploads.UploadCancelParams;

537

538public final class Main {

539 private Main() {}

540

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

542 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

543

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

545 }

546}

547```

548

549#### Response

550

551```json

552{

553 "id": "id",

554 "bytes": 0,

555 "created_at": 0,

556 "expires_at": 0,

557 "filename": "filename",

558 "object": "upload",

559 "purpose": "purpose",

560 "status": "pending",

561 "file": {

562 "id": "id",

563 "bytes": 0,

564 "created_at": 0,

565 "filename": "filename",

566 "object": "file",

567 "purpose": "assistants",

568 "status": "uploaded",

569 "expires_at": 0,

570 "status_details": "status_details"

571 }

572}

573```

574

575## Domain Types

576

577### Upload

578

579- `class Upload:`

580

581 The Upload object can accept byte chunks in the form of Parts.

582

583 - `String id`

584

585 The Upload unique identifier, which can be referenced in API endpoints.

586

587 - `long bytes`

588

589 The intended number of bytes to be uploaded.

590

591 - `long createdAt`

592

593 The Unix timestamp (in seconds) for when the Upload was created.

594

595 - `long expiresAt`

596

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

598

599 - `String filename`

600

601 The name of the file to be uploaded.

602

603 - `JsonValue; object_ "upload"constant`

604

605 The object type, which is always "upload".

606

607 - `UPLOAD("upload")`

608

609 - `String purpose`

610

611 The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values.

612

613 - `Status status`

614

615 The status of the Upload.

616

617 - `PENDING("pending")`

618

619 - `COMPLETED("completed")`

620

621 - `CANCELLED("cancelled")`

622

623 - `EXPIRED("expired")`

624

625 - `Optional<FileObject> file`

626

627 The `File` object represents a document that has been uploaded to OpenAI.

628

629 - `String id`

630

631 The file identifier, which can be referenced in the API endpoints.

632

633 - `long bytes`

634

635 The size of the file, in bytes.

636

637 - `long createdAt`

638

639 The Unix timestamp (in seconds) for when the file was created.

640

641 - `String filename`

642

643 The name of the file.

644

645 - `JsonValue; object_ "file"constant`

646

647 The object type, which is always `file`.

648

649 - `FILE("file")`

650

651 - `Purpose purpose`

652

653 The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`.

654

655 - `ASSISTANTS("assistants")`

656

657 - `ASSISTANTS_OUTPUT("assistants_output")`

658

659 - `BATCH("batch")`

660

661 - `BATCH_OUTPUT("batch_output")`

662

663 - `FINE_TUNE("fine-tune")`

664

665 - `FINE_TUNE_RESULTS("fine-tune-results")`

666

667 - `VISION("vision")`

668

669 - `USER_DATA("user_data")`

670

671 - `Status status`

672

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

674

675 - `UPLOADED("uploaded")`

676

677 - `PROCESSED("processed")`

678

679 - `ERROR("error")`

680

681 - `Optional<Long> expiresAt`

682

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

684

685 - `Optional<String> statusDetails`

686

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

688

689# Parts

690

691## Add upload part

692

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

694

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

696

697Add upload part

698

699### Parameters

700

701- `PartCreateParams params`

702

703 - `Optional<String> uploadId`

704

705 - `String data`

706

707 The chunk of bytes for this Part.

708

709### Returns

710

711- `class UploadPart:`

712

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

714

715 - `String id`

716

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

718

719 - `long createdAt`

720

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

722

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

724

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

726

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

728

729 - `String uploadId`

730

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

732

733### Example

734

735```java

736package com.openai.example;

737

738import com.openai.client.OpenAIClient;

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

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

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

742import java.io.ByteArrayInputStream;

743

744public final class Main {

745 private Main() {}

746

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

748 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

749

750 PartCreateParams params = PartCreateParams.builder()

751 .uploadId("upload_abc123")

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

753 .build();

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

755 }

756}

757```

758

759#### Response

760

761```json

762{

763 "id": "id",

764 "created_at": 0,

765 "object": "upload.part",

766 "upload_id": "upload_id"

767}

768```

769

770## Domain Types

771

772### Upload Part

773

774- `class UploadPart:`

775

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

777

778 - `String id`

779

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

781

782 - `long createdAt`

783

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

785

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

787

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

789

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

791

792 - `String uploadId`

793

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

java/resources/uploads/index.md 2026-07-07 08:02 UTC to 2026-07-09 20: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