Files

Upload file

Changed on

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and each project can store up to 2.5 TB of files in total. There is no organization-wide storage limit. Uploads to this endpoint are rate-limited to 1,000 requests per minute per authenticated user.

  • The Assistants API supports files up to 2 million tokens and of specific file types. See the Assistants Tools guide for details.
  • The Fine-tuning API only supports .jsonl files. The input also has certain required formats for fine-tuning chat or completions models.
  • The Batch API only supports .jsonl files up to 200 MB in size. The input also has a specific required format.
  • For Retrieval or file_search ingestion, upload files here first. If you need to attach multiple uploaded files to the same vector store, use /vector_stores/{vector_store_id}/file_batches instead of attaching them one by one. Vector store attachment has separate limits from file upload, including 2,000 attached files per minute per organization.

Please contact us if you need to increase these storage limits.

post/files

Request

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

Request body multipart/form-data

filestring binary required

The File object (not file name) to be uploaded.

purpose'assistants' | 'batch' | 'fine-tune' | 'vision' | 'user_data' | 'evals' required

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

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

    • info

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

  • 7eddcd50e394Revision changes
    • breaking

      the response property became nullable for the status