Sign in

Uploads a file for use by other operations.

post/files

Query parameters

api-versionstring required

The API version to use for this operation.

Response

A representation of the uploaded file.

object'file' required

The object type, which is always 'file'.

idstring required

The identifier, which can be referenced in API endpoints.

bytesinteger required

The size of the file, in bytes.

filenamestring required

The name of the file.

created_atinteger required

The Unix timestamp, in seconds, representing when this object was created.

purpose'assistants' | 'assistants_output' | 'vision' required

The possible values denoting the intended usage of a file.

status'uploaded' | 'pending' | 'running' | 'processed' | 'error' | 'deleting' | 'deleted'

The state of the file.

status_detailsstring

The error message with details in case processing of this file failed. This field is available in Azure OpenAI only.

Changes

No recorded changes to this endpoint across all 12 revisions of this API.