Files

List files

FileListPage files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /files

List files

Parameters

FileListParams params
- Optional<String> after
  
  A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
- Optional<Long> limit
  
  A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.
- Optional<Order> order
  
  Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
  - ASC("asc")
  - DESC("desc")
- Optional<String> purpose
  
  Only return files with the given purpose.

Returns

class FileObject:

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.FileListPage;
import com.openai.models.files.FileListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileListPage page = client.files().list();
    }
}

Response

{
  "data": [
    {
      "id": "id",
      "bytes": 0,
      "created_at": 0,
      "filename": "filename",
      "object": "file",
      "purpose": "assistants",
      "status": "uploaded",
      "expires_at": 0,
      "status_details": "status_details"
    }
  ],
  "first_id": "file-abc123",
  "has_more": false,
  "last_id": "file-abc456",
  "object": "list"
}

Upload file

FileObject files().create(FileCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /files

Upload file

Parameters

FileCreateParams params
- String file
  
  The File object (not file name) to be uploaded.
- JsonValue purpose
- 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 FileObject:

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.core.JsonValue;
import com.openai.models.files.FileCreateParams;
import com.openai.models.files.FileObject;
import java.io.ByteArrayInputStream;
import java.util.Map;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileCreateParams params = FileCreateParams.builder()
            .file(new ByteArrayInputStream("Example data".getBytes()))
            .purpose(JsonValue.from(<String, Object>Map.of()))
            .build();
        FileObject fileObject = client.files().create(params);
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "filename": "filename",
  "object": "file",
  "purpose": "assistants",
  "status": "uploaded",
  "expires_at": 0,
  "status_details": "status_details"
}

Delete file

FileDeleted files().delete(FileDeleteParamsparams = FileDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

delete /files/{file_id}

Delete file

Parameters

FileDeleteParams params
- Optional<String> fileId

Returns

class FileDeleted:
- String id
- boolean deleted
- JsonValue; object_ "file"constant
  - FILE("file")

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.files.FileDeleteParams;
import com.openai.models.files.FileDeleted;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileDeleted fileDeleted = client.files().delete("file_id");
    }
}

Response

{
  "id": "id",
  "deleted": true,
  "object": "file"
}

Retrieve file

FileObject files().retrieve(FileRetrieveParamsparams = FileRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /files/{file_id}

Retrieve file

Parameters

FileRetrieveParams params
- Optional<String> fileId

Returns

class FileObject:

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.FileObject;
import com.openai.models.files.FileRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileObject fileObject = client.files().retrieve("file_id");
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "filename": "filename",
  "object": "file",
  "purpose": "assistants",
  "status": "uploaded",
  "expires_at": 0,
  "status_details": "status_details"
}

Retrieve file content

HttpResponse files().content(FileContentParamsparams = FileContentParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /files/{file_id}/content

Retrieve file content

Parameters

FileContentParams params
- Optional<String> fileId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.core.http.HttpResponse;
import com.openai.models.files.FileContentParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        HttpResponse response = client.files().content("file_id");
    }
}

Domain Types

File Deleted

class FileDeleted:
- String id
- boolean deleted
- JsonValue; object_ "file"constant
  - FILE("file")

File Object

class FileObject:

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.

File Purpose

class FilePurpose:

java/resources/files/index.md +579 −0 created

1# Files

3## List files

5`FileListPage files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

7**get** `/files`

9List files

11### Parameters

13- `FileListParams params`

15 - `Optional<String> after`

17 A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

19 - `Optional<Long> limit`

21 A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.

23 - `Optional<Order> order`

25 Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

27 - `ASC("asc")`

29 - `DESC("desc")`

31 - `Optional<String> purpose`

33 Only return files with the given purpose.

35### Returns

37- `class FileObject:`

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

41 - `String id`

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

45 - `long bytes`

47 The size of the file, in bytes.

49 - `long createdAt`

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

53 - `String filename`

55 The name of the file.

57 - `JsonValue; object_ "file"constant`

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

61 - `FILE("file")`

63 - `Purpose purpose`

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

67 - `ASSISTANTS("assistants")`

69 - `ASSISTANTS_OUTPUT("assistants_output")`

71 - `BATCH("batch")`

73 - `BATCH_OUTPUT("batch_output")`

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

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

79 - `VISION("vision")`

81 - `USER_DATA("user_data")`

83 - `Status status`

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

87 - `UPLOADED("uploaded")`

89 - `PROCESSED("processed")`

91 - `ERROR("error")`

93 - `Optional<Long> expiresAt`

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

97 - `Optional<String> statusDetails`

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

100

101### Example

102

103```java

104package com.openai.example;

105

106import com.openai.client.OpenAIClient;

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

108import com.openai.models.files.FileListPage;

109import com.openai.models.files.FileListParams;

110

111public final class Main {

112 private Main() {}

113

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

115 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

116

117 FileListPage page = client.files().list();

118 }

119}

120```

121

122#### Response

123

124```json

125{

126 "data": [

127 {

128 "id": "id",

129 "bytes": 0,

130 "created_at": 0,

131 "filename": "filename",

132 "object": "file",

133 "purpose": "assistants",

134 "status": "uploaded",

135 "expires_at": 0,

136 "status_details": "status_details"

137 }

138 ],

139 "first_id": "file-abc123",

140 "has_more": false,

141 "last_id": "file-abc456",

142 "object": "list"

143}

144```

145

146## Upload file

147

148`FileObject files().create(FileCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

149

150**post** `/files`

151

152Upload file

153

154### Parameters

155

156- `FileCreateParams params`

157

158 - `String file`

159

160 The File object (not file name) to be uploaded.

161

162 - `JsonValue purpose`

163

164 - `Optional<ExpiresAfter> expiresAfter`

165

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

167

168 - `JsonValue; anchor "created_at"constant`

169

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

171

172 - `CREATED_AT("created_at")`

173

174 - `long seconds`

175

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

177

178### Returns

179

180- `class FileObject:`

181

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

183

184 - `String id`

185

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

187

188 - `long bytes`

189

190 The size of the file, in bytes.

191

192 - `long createdAt`

193

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

195

196 - `String filename`

197

198 The name of the file.

199

200 - `JsonValue; object_ "file"constant`

201

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

203

204 - `FILE("file")`

205

206 - `Purpose purpose`

207

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

209

210 - `ASSISTANTS("assistants")`

211

212 - `ASSISTANTS_OUTPUT("assistants_output")`

213

214 - `BATCH("batch")`

215

216 - `BATCH_OUTPUT("batch_output")`

217

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

219

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

221

222 - `VISION("vision")`

223

224 - `USER_DATA("user_data")`

225

226 - `Status status`

227

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

229

230 - `UPLOADED("uploaded")`

231

232 - `PROCESSED("processed")`

233

234 - `ERROR("error")`

235

236 - `Optional<Long> expiresAt`

237

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

239

240 - `Optional<String> statusDetails`

241

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

243

244### Example

245

246```java

247package com.openai.example;

248

249import com.openai.client.OpenAIClient;

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

251import com.openai.core.JsonValue;

252import com.openai.models.files.FileCreateParams;

253import com.openai.models.files.FileObject;

254import java.io.ByteArrayInputStream;

255import java.util.Map;

256

257public final class Main {

258 private Main() {}

259

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

261 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

262

263 FileCreateParams params = FileCreateParams.builder()

264 .file(new ByteArrayInputStream("Example data".getBytes()))

265 .purpose(JsonValue.from(<String, Object>Map.of()))

266 .build();

267 FileObject fileObject = client.files().create(params);

268 }

269}

270```

271

272#### Response

273

274```json

275{

276 "id": "id",

277 "bytes": 0,

278 "created_at": 0,

279 "filename": "filename",

280 "object": "file",

281 "purpose": "assistants",

282 "status": "uploaded",

283 "expires_at": 0,

284 "status_details": "status_details"

285}

286```

287

288## Delete file

289

290`FileDeleted files().delete(FileDeleteParamsparams = FileDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

291

292**delete** `/files/{file_id}`

293

294Delete file

295

296### Parameters

297

298- `FileDeleteParams params`

299

300 - `Optional<String> fileId`

301

302### Returns

303

304- `class FileDeleted:`

305

306 - `String id`

307

308 - `boolean deleted`

309

310 - `JsonValue; object_ "file"constant`

311

312 - `FILE("file")`

313

314### Example

315

316```java

317package com.openai.example;

318

319import com.openai.client.OpenAIClient;

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

321import com.openai.models.files.FileDeleteParams;

322import com.openai.models.files.FileDeleted;

323

324public final class Main {

325 private Main() {}

326

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

328 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

329

330 FileDeleted fileDeleted = client.files().delete("file_id");

331 }

332}

333```

334

335#### Response

336

337```json

338{

339 "id": "id",

340 "deleted": true,

341 "object": "file"

342}

343```

344

345## Retrieve file

346

347`FileObject files().retrieve(FileRetrieveParamsparams = FileRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

348

349**get** `/files/{file_id}`

350

351Retrieve file

352

353### Parameters

354

355- `FileRetrieveParams params`

356

357 - `Optional<String> fileId`

358

359### Returns

360

361- `class FileObject:`

362

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

364

365 - `String id`

366

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

368

369 - `long bytes`

370

371 The size of the file, in bytes.

372

373 - `long createdAt`

374

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

376

377 - `String filename`

378

379 The name of the file.

380

381 - `JsonValue; object_ "file"constant`

382

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

384

385 - `FILE("file")`

386

387 - `Purpose purpose`

388

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

390

391 - `ASSISTANTS("assistants")`

392

393 - `ASSISTANTS_OUTPUT("assistants_output")`

394

395 - `BATCH("batch")`

396

397 - `BATCH_OUTPUT("batch_output")`

398

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

400

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

402

403 - `VISION("vision")`

404

405 - `USER_DATA("user_data")`

406

407 - `Status status`

408

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

410

411 - `UPLOADED("uploaded")`

412

413 - `PROCESSED("processed")`

414

415 - `ERROR("error")`

416

417 - `Optional<Long> expiresAt`

418

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

420

421 - `Optional<String> statusDetails`

422

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

424

425### Example

426

427```java

428package com.openai.example;

429

430import com.openai.client.OpenAIClient;

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

432import com.openai.models.files.FileObject;

433import com.openai.models.files.FileRetrieveParams;

434

435public final class Main {

436 private Main() {}

437

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

439 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

440

441 FileObject fileObject = client.files().retrieve("file_id");

442 }

443}

444```

445

446#### Response

447

448```json

449{

450 "id": "id",

451 "bytes": 0,

452 "created_at": 0,

453 "filename": "filename",

454 "object": "file",

455 "purpose": "assistants",

456 "status": "uploaded",

457 "expires_at": 0,

458 "status_details": "status_details"

459}

460```

461

462## Retrieve file content

463

464`HttpResponse files().content(FileContentParamsparams = FileContentParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

465

466**get** `/files/{file_id}/content`

467

468Retrieve file content

469

470### Parameters

471

472- `FileContentParams params`

473

474 - `Optional<String> fileId`

475

476### Example

477

478```java

479package com.openai.example;

480

481import com.openai.client.OpenAIClient;

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

483import com.openai.core.http.HttpResponse;

484import com.openai.models.files.FileContentParams;

485

486public final class Main {

487 private Main() {}

488

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

490 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

491

492 HttpResponse response = client.files().content("file_id");

493 }

494}

495```

496

497## Domain Types

498

499### File Deleted

500

501- `class FileDeleted:`

502

503 - `String id`

504

505 - `boolean deleted`

506

507 - `JsonValue; object_ "file"constant`

508

509 - `FILE("file")`

510

511### File Object

512

513- `class FileObject:`

514

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

516

517 - `String id`

518

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

520

521 - `long bytes`

522

523 The size of the file, in bytes.

524

525 - `long createdAt`

526

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

528

529 - `String filename`

530

531 The name of the file.

532

533 - `JsonValue; object_ "file"constant`

534

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

536

537 - `FILE("file")`

538

539 - `Purpose purpose`

540

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

542

543 - `ASSISTANTS("assistants")`

544

545 - `ASSISTANTS_OUTPUT("assistants_output")`

546

547 - `BATCH("batch")`

548

549 - `BATCH_OUTPUT("batch_output")`

550

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

552

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

554

555 - `VISION("vision")`

556

557 - `USER_DATA("user_data")`

558

559 - `Status status`

560

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

562

563 - `UPLOADED("uploaded")`

564

565 - `PROCESSED("processed")`

566

567 - `ERROR("error")`

568

569 - `Optional<Long> expiresAt`

570

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

572

573 - `Optional<String> statusDetails`

574

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

576

577### File Purpose

578

579- `class FilePurpose:`

java/resources/files/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

Files

List files

Parameters

Returns

Example

Response

Upload file

Parameters

Returns

Example

Response

Delete file

Parameters

Returns

Example

Response

Retrieve file

Parameters

Returns

Example

Response

Retrieve file content

Parameters

Example

Domain Types

File Deleted

File Object

File Purpose