Skip to content
API Reference

Files

List files
client.files.list(FileListParams { after, limit, order, purpose } query?, RequestOptionsoptions?): CursorPage<FileObject { id, bytes, created_at, 6 more } >
GET/files
Upload file
client.files.create(FileCreateParams { file, purpose, expires_after } body, RequestOptionsoptions?): FileObject { id, bytes, created_at, 6 more }
POST/files
Delete file
client.files.delete(stringfileID, RequestOptionsoptions?): FileDeleted { id, deleted, object }
DELETE/files/{file_id}
Retrieve file
client.files.retrieve(stringfileID, RequestOptionsoptions?): FileObject { id, bytes, created_at, 6 more }
GET/files/{file_id}
Retrieve file content
client.files.content(stringfileID, RequestOptionsoptions?): Response
GET/files/{file_id}/content
ModelsExpand Collapse
FileContent = string
FileDeleted { id, deleted, object }
id: string
deleted: boolean
object: "file"
FileObject { 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" | "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: "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?: number

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

Deprecatedstatus_details?: string

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

FilePurpose = "assistants" | "batch" | "fine-tune" | 3 more

The intended purpose of the uploaded file. One of:

  • assistants: Used in the Assistants API
  • batch: Used in the Batch API
  • fine-tune: Used for fine-tuning
  • vision: Images used for vision fine-tuning
  • user_data: Flexible file type for any purpose
  • evals: Used for eval data sets
Accepts one of the following:
"assistants"
"batch"
"fine-tune"
"vision"
"user_data"
"evals"