Uploads

Create upload

$ openai uploads create

post /uploads

Create upload

Parameters

--bytes: number

The number of bytes in the file you are uploading.
--filename: string

The name of the file to upload.
--mime-type: string

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.
--purpose: unknown

The intended purpose of the uploaded file.

See the documentation on File purposes.
--expires-after: optional object { anchor, seconds }

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.

Returns

upload: object { id, bytes, created_at, 6 more }

The Upload object can accept byte chunks in the form of Parts.
- id: string
  
  The Upload unique identifier, which can be referenced in API endpoints.
- bytes: number
  
  The intended number of bytes to be uploaded.
- created_at: number
  
  The Unix timestamp (in seconds) for when the Upload was created.
- expires_at: number
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- filename: string
  
  The name of the file to be uploaded.
- object: "upload"
  
  The object type, which is always "upload".
- purpose: string
  
  The intended purpose of the file. Please refer here for acceptable values.
- status: "pending" or "completed" or "cancelled" or "expired"
  
  The status of the Upload.
  - "pending"
  - "completed"
  - "cancelled"
  - "expired"
- file: optional object { id, bytes, created_at, 6 more }
  
  The File object represents a document that has been uploaded to OpenAI.
  - id: string
    
    The file identifier, which can be referenced in the API endpoints.
  - bytes: number
    
    The size of the file, in bytes.
  - created_at: number
    
    The Unix timestamp (in seconds) for when the file was created.
  - filename: string
    
    The name of the file.
  - object: "file"
    
    The object type, which is always file.
  - purpose: "assistants" or "assistants_output" or "batch" or 5 more
    
    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_output"
    - "batch"
    - "batch_output"
    - "fine-tune"
    - "fine-tune-results"
    - "vision"
    - "user_data"
  - status: "uploaded" or "processed" or "error"
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - "uploaded"
    - "processed"
    - "error"
  - expires_at: optional number
    
    The Unix timestamp (in seconds) for when the file will expire.
  - status_details: optional string
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

openai uploads create \
  --api-key 'My API Key' \
  --bytes 0 \
  --filename filename \
  --mime-type mime_type \
  --purpose '{}'

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

$ openai uploads complete

post /uploads/{upload_id}/complete

Complete upload

Parameters

--upload-id: string

The ID of the Upload.
--part-id: array of string

The ordered list of Part IDs.
--md5: optional string

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

Returns

upload: object { id, bytes, created_at, 6 more }

The Upload object can accept byte chunks in the form of Parts.
- id: string
  
  The Upload unique identifier, which can be referenced in API endpoints.
- bytes: number
  
  The intended number of bytes to be uploaded.
- created_at: number
  
  The Unix timestamp (in seconds) for when the Upload was created.
- expires_at: number
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- filename: string
  
  The name of the file to be uploaded.
- object: "upload"
  
  The object type, which is always "upload".
- purpose: string
  
  The intended purpose of the file. Please refer here for acceptable values.
- status: "pending" or "completed" or "cancelled" or "expired"
  
  The status of the Upload.
  - "pending"
  - "completed"
  - "cancelled"
  - "expired"
- file: optional object { id, bytes, created_at, 6 more }
  
  The File object represents a document that has been uploaded to OpenAI.
  - id: string
    
    The file identifier, which can be referenced in the API endpoints.
  - bytes: number
    
    The size of the file, in bytes.
  - created_at: number
    
    The Unix timestamp (in seconds) for when the file was created.
  - filename: string
    
    The name of the file.
  - object: "file"
    
    The object type, which is always file.
  - purpose: "assistants" or "assistants_output" or "batch" or 5 more
    
    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_output"
    - "batch"
    - "batch_output"
    - "fine-tune"
    - "fine-tune-results"
    - "vision"
    - "user_data"
  - status: "uploaded" or "processed" or "error"
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - "uploaded"
    - "processed"
    - "error"
  - expires_at: optional number
    
    The Unix timestamp (in seconds) for when the file will expire.
  - status_details: optional string
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

openai uploads complete \
  --api-key 'My API Key' \
  --upload-id upload_abc123 \
  --part-id string

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

$ openai uploads cancel

post /uploads/{upload_id}/cancel

Cancel upload

Parameters

--upload-id: string

The ID of the Upload.

Returns

upload: object { id, bytes, created_at, 6 more }

The Upload object can accept byte chunks in the form of Parts.
- id: string
  
  The Upload unique identifier, which can be referenced in API endpoints.
- bytes: number
  
  The intended number of bytes to be uploaded.
- created_at: number
  
  The Unix timestamp (in seconds) for when the Upload was created.
- expires_at: number
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- filename: string
  
  The name of the file to be uploaded.
- object: "upload"
  
  The object type, which is always "upload".
- purpose: string
  
  The intended purpose of the file. Please refer here for acceptable values.
- status: "pending" or "completed" or "cancelled" or "expired"
  
  The status of the Upload.
  - "pending"
  - "completed"
  - "cancelled"
  - "expired"
- file: optional object { id, bytes, created_at, 6 more }
  
  The File object represents a document that has been uploaded to OpenAI.
  - id: string
    
    The file identifier, which can be referenced in the API endpoints.
  - bytes: number
    
    The size of the file, in bytes.
  - created_at: number
    
    The Unix timestamp (in seconds) for when the file was created.
  - filename: string
    
    The name of the file.
  - object: "file"
    
    The object type, which is always file.
  - purpose: "assistants" or "assistants_output" or "batch" or 5 more
    
    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_output"
    - "batch"
    - "batch_output"
    - "fine-tune"
    - "fine-tune-results"
    - "vision"
    - "user_data"
  - status: "uploaded" or "processed" or "error"
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - "uploaded"
    - "processed"
    - "error"
  - expires_at: optional number
    
    The Unix timestamp (in seconds) for when the file will expire.
  - status_details: optional string
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

openai uploads cancel \
  --api-key 'My API Key' \
  --upload-id 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

upload: object { id, bytes, created_at, 6 more }

The Upload object can accept byte chunks in the form of Parts.
- id: string
  
  The Upload unique identifier, which can be referenced in API endpoints.
- bytes: number
  
  The intended number of bytes to be uploaded.
- created_at: number
  
  The Unix timestamp (in seconds) for when the Upload was created.
- expires_at: number
  
  The Unix timestamp (in seconds) for when the Upload will expire.
- filename: string
  
  The name of the file to be uploaded.
- object: "upload"
  
  The object type, which is always "upload".
- purpose: string
  
  The intended purpose of the file. Please refer here for acceptable values.
- status: "pending" or "completed" or "cancelled" or "expired"
  
  The status of the Upload.
  - "pending"
  - "completed"
  - "cancelled"
  - "expired"
- file: optional object { id, bytes, created_at, 6 more }
  
  The File object represents a document that has been uploaded to OpenAI.
  - id: string
    
    The file identifier, which can be referenced in the API endpoints.
  - bytes: number
    
    The size of the file, in bytes.
  - created_at: number
    
    The Unix timestamp (in seconds) for when the file was created.
  - filename: string
    
    The name of the file.
  - object: "file"
    
    The object type, which is always file.
  - purpose: "assistants" or "assistants_output" or "batch" or 5 more
    
    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_output"
    - "batch"
    - "batch_output"
    - "fine-tune"
    - "fine-tune-results"
    - "vision"
    - "user_data"
  - status: "uploaded" or "processed" or "error"
    
    Deprecated. The current status of the file, which can be either uploaded, processed, or error.
    - "uploaded"
    - "processed"
    - "error"
  - expires_at: optional number
    
    The Unix timestamp (in seconds) for when the file will expire.
  - status_details: optional string
    
    Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Parts

Add upload part

$ openai uploads:parts create

post /uploads/{upload_id}/parts

Add upload part

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

1# Uploads

3## Create upload

5`$ openai uploads create`

7**post** `/uploads`

9Create upload

11### Parameters

13- `--bytes: number`

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

17- `--filename: string`

19 The name of the file to upload.

21- `--mime-type: string`

23 The MIME type of the file.

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

26 the supported MIME types for assistants and vision.

28- `--purpose: unknown`

30 The intended purpose of the uploaded file.

32 See the [documentation on File

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

35- `--expires-after: optional object { anchor, seconds }`

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

39### Returns

41- `upload: object { id, bytes, created_at, 6 more }`

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

45 - `id: string`

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

49 - `bytes: number`

51 The intended number of bytes to be uploaded.

53 - `created_at: number`

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

57 - `expires_at: number`

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

61 - `filename: string`

63 The name of the file to be uploaded.

65 - `object: "upload"`

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

69 - `purpose: string`

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

73 - `status: "pending" or "completed" or "cancelled" or "expired"`

75 The status of the Upload.

77 - `"pending"`

79 - `"completed"`

81 - `"cancelled"`

83 - `"expired"`

85 - `file: optional object { id, bytes, created_at, 6 more }`

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

89 - `id: string`

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

93 - `bytes: number`

95 The size of the file, in bytes.

97 - `created_at: number`

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

100

101 - `filename: string`

102

103 The name of the file.

104

105 - `object: "file"`

106

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

108

109 - `purpose: "assistants" or "assistants_output" or "batch" or 5 more`

110

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

112

113 - `"assistants"`

114

115 - `"assistants_output"`

116

117 - `"batch"`

118

119 - `"batch_output"`

120

121 - `"fine-tune"`

122

123 - `"fine-tune-results"`

124

125 - `"vision"`

126

127 - `"user_data"`

128

129 - `status: "uploaded" or "processed" or "error"`

130

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

132

133 - `"uploaded"`

134

135 - `"processed"`

136

137 - `"error"`

138

139 - `expires_at: optional number`

140

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

142

143 - `status_details: optional string`

144

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

146

147### Example

148

149```cli

150openai uploads create \

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

152 --bytes 0 \

153 --filename filename \

154 --mime-type mime_type \

155 --purpose '{}'

156```

157

158#### Response

159

160```json

161{

162 "id": "id",

163 "bytes": 0,

164 "created_at": 0,

165 "expires_at": 0,

166 "filename": "filename",

167 "object": "upload",

168 "purpose": "purpose",

169 "status": "pending",

170 "file": {

171 "id": "id",

172 "bytes": 0,

173 "created_at": 0,

174 "filename": "filename",

175 "object": "file",

176 "purpose": "assistants",

177 "status": "uploaded",

178 "expires_at": 0,

179 "status_details": "status_details"

180 }

181}

182```

183

184## Complete upload

185

186`$ openai uploads complete`

187

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

189

190Complete upload

191

192### Parameters

193

194- `--upload-id: string`

195

196 The ID of the Upload.

197

198- `--part-id: array of string`

199

200 The ordered list of Part IDs.

201

202- `--md5: optional string`

203

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

205

206### Returns

207

208- `upload: object { id, bytes, created_at, 6 more }`

209

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

211

212 - `id: string`

213

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

215

216 - `bytes: number`

217

218 The intended number of bytes to be uploaded.

219

220 - `created_at: number`

221

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

223

224 - `expires_at: number`

225

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

227

228 - `filename: string`

229

230 The name of the file to be uploaded.

231

232 - `object: "upload"`

233

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

235

236 - `purpose: string`

237

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

239

240 - `status: "pending" or "completed" or "cancelled" or "expired"`

241

242 The status of the Upload.

243

244 - `"pending"`

245

246 - `"completed"`

247

248 - `"cancelled"`

249

250 - `"expired"`

251

252 - `file: optional object { id, bytes, created_at, 6 more }`

253

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

255

256 - `id: string`

257

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

259

260 - `bytes: number`

261

262 The size of the file, in bytes.

263

264 - `created_at: number`

265

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

267

268 - `filename: string`

269

270 The name of the file.

271

272 - `object: "file"`

273

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

275

276 - `purpose: "assistants" or "assistants_output" or "batch" or 5 more`

277

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

279

280 - `"assistants"`

281

282 - `"assistants_output"`

283

284 - `"batch"`

285

286 - `"batch_output"`

287

288 - `"fine-tune"`

289

290 - `"fine-tune-results"`

291

292 - `"vision"`

293

294 - `"user_data"`

295

296 - `status: "uploaded" or "processed" or "error"`

297

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

299

300 - `"uploaded"`

301

302 - `"processed"`

303

304 - `"error"`

305

306 - `expires_at: optional number`

307

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

309

310 - `status_details: optional string`

311

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

313

314### Example

315

316```cli

317openai uploads complete \

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

319 --upload-id upload_abc123 \

320 --part-id string

321```

322

323#### Response

324

325```json

326{

327 "id": "id",

328 "bytes": 0,

329 "created_at": 0,

330 "expires_at": 0,

331 "filename": "filename",

332 "object": "upload",

333 "purpose": "purpose",

334 "status": "pending",

335 "file": {

336 "id": "id",

337 "bytes": 0,

338 "created_at": 0,

339 "filename": "filename",

340 "object": "file",

341 "purpose": "assistants",

342 "status": "uploaded",

343 "expires_at": 0,

344 "status_details": "status_details"

345 }

346}

347```

348

349## Cancel upload

350

351`$ openai uploads cancel`

352

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

354

355Cancel upload

356

357### Parameters

358

359- `--upload-id: string`

360

361 The ID of the Upload.

362

363### Returns

364

365- `upload: object { id, bytes, created_at, 6 more }`

366

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

368

369 - `id: string`

370

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

372

373 - `bytes: number`

374

375 The intended number of bytes to be uploaded.

376

377 - `created_at: number`

378

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

380

381 - `expires_at: number`

382

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

384

385 - `filename: string`

386

387 The name of the file to be uploaded.

388

389 - `object: "upload"`

390

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

392

393 - `purpose: string`

394

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

396

397 - `status: "pending" or "completed" or "cancelled" or "expired"`

398

399 The status of the Upload.

400

401 - `"pending"`

402

403 - `"completed"`

404

405 - `"cancelled"`

406

407 - `"expired"`

408

409 - `file: optional object { id, bytes, created_at, 6 more }`

410

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

412

413 - `id: string`

414

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

416

417 - `bytes: number`

418

419 The size of the file, in bytes.

420

421 - `created_at: number`

422

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

424

425 - `filename: string`

426

427 The name of the file.

428

429 - `object: "file"`

430

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

432

433 - `purpose: "assistants" or "assistants_output" or "batch" or 5 more`

434

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

436

437 - `"assistants"`

438

439 - `"assistants_output"`

440

441 - `"batch"`

442

443 - `"batch_output"`

444

445 - `"fine-tune"`

446

447 - `"fine-tune-results"`

448

449 - `"vision"`

450

451 - `"user_data"`

452

453 - `status: "uploaded" or "processed" or "error"`

454

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

456

457 - `"uploaded"`

458

459 - `"processed"`

460

461 - `"error"`

462

463 - `expires_at: optional number`

464

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

466

467 - `status_details: optional string`

468

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

470

471### Example

472

473```cli

474openai uploads cancel \

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

476 --upload-id upload_abc123

477```

478

479#### Response

480

481```json

482{

483 "id": "id",

484 "bytes": 0,

485 "created_at": 0,

486 "expires_at": 0,

487 "filename": "filename",

488 "object": "upload",

489 "purpose": "purpose",

490 "status": "pending",

491 "file": {

492 "id": "id",

493 "bytes": 0,

494 "created_at": 0,

495 "filename": "filename",

496 "object": "file",

497 "purpose": "assistants",

498 "status": "uploaded",

499 "expires_at": 0,

500 "status_details": "status_details"

501 }

502}

503```

504

505## Domain Types

506

507### Upload

508

509- `upload: object { id, bytes, created_at, 6 more }`

510

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

512

513 - `id: string`

514

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

516

517 - `bytes: number`

518

519 The intended number of bytes to be uploaded.

520

521 - `created_at: number`

522

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

524

525 - `expires_at: number`

526

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

528

529 - `filename: string`

530

531 The name of the file to be uploaded.

532

533 - `object: "upload"`

534

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

536

537 - `purpose: string`

538

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

540

541 - `status: "pending" or "completed" or "cancelled" or "expired"`

542

543 The status of the Upload.

544

545 - `"pending"`

546

547 - `"completed"`

548

549 - `"cancelled"`

550

551 - `"expired"`

552

553 - `file: optional object { id, bytes, created_at, 6 more }`

554

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

556

557 - `id: string`

558

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

560

561 - `bytes: number`

562

563 The size of the file, in bytes.

564

565 - `created_at: number`

566

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

568

569 - `filename: string`

570

571 The name of the file.

572

573 - `object: "file"`

574

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

576

577 - `purpose: "assistants" or "assistants_output" or "batch" or 5 more`

578

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

580

581 - `"assistants"`

582

583 - `"assistants_output"`

584

585 - `"batch"`

586

587 - `"batch_output"`

588

589 - `"fine-tune"`

590

591 - `"fine-tune-results"`

592

593 - `"vision"`

594

595 - `"user_data"`

596

597 - `status: "uploaded" or "processed" or "error"`

598

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

600

601 - `"uploaded"`

602

603 - `"processed"`

604

605 - `"error"`

606

607 - `expires_at: optional number`

608

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

610

611 - `status_details: optional string`

612

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

614

615# Parts

616

617## Add upload part

618

619`$ openai uploads:parts create`

620

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

622

623Add upload part

624

625### Parameters

626

627- `--upload-id: string`

628

629 The ID of the Upload.

630

631- `--data: string`

632

633 The chunk of bytes for this Part.

634

635### Returns

636

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

638

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

640

641 - `id: string`

642

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

644

645 - `created_at: number`

646

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

648

649 - `object: "upload.part"`

650

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

652

653 - `upload_id: string`

654

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

656

657### Example

658

659```cli

660openai uploads:parts create \

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

662 --upload-id upload_abc123 \

663 --data 'Example data'

664```

665

666#### Response

667

668```json

669{

670 "id": "id",

671 "created_at": 0,

672 "object": "upload.part",

673 "upload_id": "upload_id"

674}

675```

676

677## Domain Types

678

679### Upload Part

680

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

682

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

684

685 - `id: string`

686

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

688

689 - `created_at: number`

690

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

692

693 - `object: "upload.part"`

694

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

696

697 - `upload_id: string`

698

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

cli/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