Files

Retrieve file

Changed on

Returns information about a specific file.

get/files/{file_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/files/{file_id}
  • Auth
    HTTP bearer

Path parameters

file_idstring required

The ID of the file to use for this request.

Response

OK

idstring required

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

bytesinteger nullable required

The size of the file, in bytes. In a completed file upload response, this can be null when the file size is not yet available.

created_atinteger required

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

expires_atinteger

The Unix timestamp (in seconds) for when the file will expire. In a completed file upload response, this can be null when no expiry is set.

filenamestring required

The name of the file.

object'file' required

The object type, which is always file.

purpose'assistants' | 'assistants_output' | 'batch' | 'batch_output' | 'fine-tune' | 'fine-tune-results' | 'vision' | 'user_data' required

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

status'uploaded' | 'processed' | 'error' required

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

status_detailsstring

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job. Completed file upload responses can return null when these details are unset.

Changes

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 7eddcd50e394Revision changes
    • breaking

      the response property became nullable for the status