cli/resources/files/methods/retrieve/index.md

Retrieve file

$ openai files retrieve

get /files/{file_id}

Returns information about a specific file.

Parameters

--file-id: string

The ID of the file to use for this request.

Returns

file_object: 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 files retrieve \
  --api-key 'My API Key' \
  --file-id 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"
}

cli/resources/files/methods/retrieve/index.md +101 −0 created

1## Retrieve file

3`$ openai files retrieve`

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

7Returns information about a specific file.

9### Parameters

11- `--file-id: string`

13 The ID of the file to use for this request.

15### Returns

17- `file_object: object { id, bytes, created_at, 6 more }`

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

21 - `id: string`

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

25 - `bytes: number`

27 The size of the file, in bytes.

29 - `created_at: number`

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

33 - `filename: string`

35 The name of the file.

37 - `object: "file"`

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

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

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

45 - `"assistants"`

47 - `"assistants_output"`

49 - `"batch"`

51 - `"batch_output"`

53 - `"fine-tune"`

55 - `"fine-tune-results"`

57 - `"vision"`

59 - `"user_data"`

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

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

65 - `"uploaded"`

67 - `"processed"`

69 - `"error"`

71 - `expires_at: optional number`

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

75 - `status_details: optional string`

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

79### Example

81```cli

82openai files retrieve \

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

84 --file-id file_id

85```

87#### Response

89```json

90{

91 "id": "id",

92 "bytes": 0,

93 "created_at": 0,

94 "filename": "filename",

95 "object": "file",

96 "purpose": "assistants",

97 "status": "uploaded",

98 "expires_at": 0,

99 "status_details": "status_details"

100}

101```