ruby/resources/files/methods/create/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

Upload file

files.create(**kwargs) -> FileObject

post /files

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.

Parameters

• file: String

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

• purpose: FilePurpose

  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

  • :assistants

  • :batch

  • :"fine-tune"

  • :vision

  • :user_data

  • :evals

• expires_after: ExpiresAfter{ anchor, seconds}

  The expiration policy for a file. By default, files with purpose=batch expire after 30 days and all other files are persisted until they are manually deleted.

  • anchor: :created_at

    Anchor timestamp after which the expiration policy applies. Supported anchors: created_at.

    • :created_at

  • seconds: Integer

    The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).

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.create(file: StringIO.new("Example data"), purpose: :assistants)

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"
}