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

Retrieve file

files.retrieve(file_id) -> FileObject

get /files/{file_id}

Retrieve file

Parameters

file_id: String

Returns

class FileObject

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: Integer
  
  The size of the file, in bytes.
- created_at: Integer
  
  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.
  - :file
- purpose: :assistants | :assistants_output | :batch | 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 | :processed | :error
  
  Deprecated. The current status of the file, which can be either uploaded, processed, or error.
  - :uploaded
  - :processed
  - :error
- expires_at: Integer
  
  The Unix timestamp (in seconds) for when the file will expire.
- status_details: String
  
  Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

file_object = openai.files.retrieve("file_id")

puts(file_object)

Response

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

ruby/resources/files/methods/retrieve/index.md +105 −0 created

1## Retrieve file

3`files.retrieve(file_id) -> FileObject`

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

7Retrieve file

9### Parameters

11- `file_id: String`

13### Returns

15- `class FileObject`

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

19 - `id: String`

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

23 - `bytes: Integer`

25 The size of the file, in bytes.

27 - `created_at: Integer`

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

31 - `filename: String`

33 The name of the file.

35 - `object: :file`

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

39 - `:file`

41 - `purpose: :assistants | :assistants_output | :batch | 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 | :processed | :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: Integer`

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

75 - `status_details: 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```ruby

82require "openai"

84openai = OpenAI::Client.new(api_key: "My API Key")

86file_object = openai.files.retrieve("file_id")

88puts(file_object)

89```

91#### Response

93```json

94{

95 "id": "id",

96 "bytes": 0,

97 "created_at": 0,

98 "filename": "filename",

99 "object": "file",

100 "purpose": "assistants",

101 "status": "uploaded",

102 "expires_at": 0,

103 "status_details": "status_details"

104}

105```

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

Retrieve file

Parameters

Returns

Example

Response