Interface Upload

The Upload object can accept byte chunks in the form of Parts.

interface Upload {
    bytes: number;
    created_at: number;
    expires_at: number;
    filename: string;
    id: string;
    object: "upload";
    purpose: string;
    status:
        | "completed"
        | "cancelled"
        | "expired"
        | "pending";
    file?: null | FileObject;
}

Properties

bytes created_at expires_at filename id object purpose status file?

Properties

bytes

bytes: number

The intended number of bytes to be uploaded.

created_at

created_at: number

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

expires_at

expires_at: number

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

filename

filename: string

The name of the file to be uploaded.

id

id: string

The Upload unique identifier, which can be referenced in API endpoints.

object

object: "upload"

The object type, which is always "upload".

purpose

purpose: string

The intended purpose of the file. Please refer here for acceptable values.

status

status:
    | "completed"
    | "cancelled"
    | "expired"
    | "pending"

The status of the Upload.

Optionalfile

file?: null | FileObject

The ready File object after the Upload is completed.

Settings

Member Visibility

On This Page

Properties