Sign in

v3

latestSwagger 2.02026-07-1342207288.7 KB

Returns information about a specific file. Does not retrieve file content.

get/files/{fileId}

Path parameters

fileIdstring required

The ID of the file to retrieve.

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The request has succeeded.

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.