Interface AssistantFileModel

The response format for a successful file upload request.

Export

AssistantFileModel

interface AssistantFileModel {
    createdOn?: Date;
    id: string;
    metadata?: null | object;
    multimodal?: boolean;
    name: string;
    signedUrl?: null | string;
    size?: number;
    status?: string;
    updatedOn?: Date;
}

Properties

createdOn? id metadata? multimodal? name signedUrl? size? status? updatedOn?

Properties

OptionalcreatedOn

createdOn?: Date

The timestamp when the file was uploaded, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

Memberof

AssistantFileModel

id

id: string

The unique identifier for the uploaded file. This may be a user-provided identifier or a system-generated ID.

Memberof

AssistantFileModel

Optionalmetadata

metadata?: null | object

Optional metadata associated with the file. This metadata can be used to filter files when listing them or to restrict search results when querying the assistant.

Memberof

AssistantFileModel

Optionalmultimodal

multimodal?: boolean

Indicates whether the file was processed as multimodal.

Memberof

AssistantFileModel

name

name: string

The name of the uploaded file.

Memberof

AssistantFileModel

OptionalsignedUrl

signedUrl?: null | string

A signed URL that provides temporary, read-only access to the file. Anyone with the link can access the file, so treat it as sensitive data. Expires after a short time.

Memberof

AssistantFileModel

Optionalsize

size?: number

The size of the uploaded file, in bytes.

Memberof

AssistantFileModel

Optionalstatus

status?: string

The current state of the uploaded file. Possible values:

  • Processing: File is being processed (parsed, chunked, embedded)
  • Available: Processing completed successfully; file is ready for use
  • Deleting: Deletion has been initiated but not yet completed
  • ProcessingFailed: Processing failed with an error

Note: Once a file is deleted, the API returns 404 Not Found instead of a file object.

Memberof

AssistantFileModel

OptionalupdatedOn

updatedOn?: Date

The timestamp of the most recent update to the file, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

Memberof

AssistantFileModel

Settings

Member Visibility

On This Page

Properties