Retrieve file

files.retrieve() -> FileObject

GET/files/{file_id}

Returns information about a specific file.

ParametersExpand Collapse

file_id: str

ReturnsExpand Collapse

class FileObject: …

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

id: str

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

bytes: int

The size of the file, in bytes.

created_at: int

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

filename: str

The name of the file.

object: Literal["file"]

The object type, which is always file.

purpose: Literal["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.

Accepts one of the following:

"assistants"

"assistants_output"

"batch"

"batch_output"

"fine-tune"

"fine-tune-results"

"vision"

"user_data"

Deprecatedstatus: Literal["uploaded", "processed", "error"]

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

Accepts one of the following:

"uploaded"

"processed"

"error"

expires_at: Optional[int]

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

Deprecatedstatus_details: Optional[str]

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

Retrieve file

from openai import OpenAI
client = OpenAI()

client.files.retrieve("file-abc123")

{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "expires_at": 1677614202,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune",
}

Returns Examples

{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "expires_at": 1677614202,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune",
}