Dateien

Datei hochladen

client.files.upload(params, options?): FileMetadata

POST/v1/files

Dateien auflisten

client.files.list(params?, options?): PageCursor<FileMetadata>

GET/v1/files

Datei herunterladen

client.files.download(fileID, params?, options?): Response

GET/v1/files/{file_id}/content

Dateimetadaten abrufen

client.files.retrieveMetadata(fileID, params?, options?): FileMetadata

GET/v1/files/{file_id}

Datei löschen

client.files.delete(fileID, params?, options?): DeletedFile

DELETE/v1/files/{file_id}

Models

interface DeletedFile { type: "file_deleted"; id }

type?: "file_deleted"

Deleted object type.

For file deletion, this is always "file_deleted".

defaultfile_deleted

id: string

ID of the deleted file.

interface FileMetadata { type: "file"; id; created_at; /* 5 more */ }

type: "file"

Object type.

For files, this is always "file".

id: string

Unique object identifier.

The format and length of IDs may change over time.

created_at: string

RFC 3339 datetime string representing when the file was created.

formatdate-time

filename: string

Original filename of the uploaded file.

minLength1

maxLength500

mime_type: string

MIME type of the file.

minLength1

maxLength255

size_bytes: number

Size of the file in bytes.

minimum0

downloadable?: boolean

Whether the file can be downloaded.

defaultfalse

expires_at?: string | null

RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with expires_in_seconds, this is the upload time plus that value.

formatdate-time