POST
/
files

Authorizations

x-portkey-api-key
string
headerrequired

Body

multipart/form-data
file
file
required

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

purpose
enum<string>
required

The intended purpose of the uploaded file.

Use "assistants" for Assistants and Message files, "vision" for Assistants image file inputs, "batch" for Batch API, and "fine-tune" for Fine-tuning.

Available options:
assistants,
batch,
fine-tune,
vision

Response

200 - application/json

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

id
string
required

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

bytes
integer
required

The size of the file, in bytes.

created_at
integer
required

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

filename
string
required

The name of the file.

object
enum<string>
required

The object type, which is always file.

Available options:
file
purpose
enum<string>
required

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

Available options:
assistants,
assistants_output,
batch,
batch_output,
fine-tune,
fine-tune-results,
vision
status
enum<string>
requireddeprecated

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

Available options:
uploaded,
processed,
error
status_details
string
deprecated

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