Dateien

Datei hochladen

files.upload(**kwargs) -> FileMetadata

POST/v1/files

Dateien auflisten

files.list(**kwargs) -> PageCursor<FileMetadata>

GET/v1/files

Datei herunterladen

files.download(file_id, **kwargs) -> StringIO

GET/v1/files/{file_id}/content

Dateimetadaten abrufen

files.retrieve_metadata(file_id, **kwargs) -> FileMetadata

GET/v1/files/{file_id}

Datei löschen

files.delete(file_id, **kwargs) -> DeletedFile

DELETE/v1/files/{file_id}

Models

class DeletedFile { type: :file_deleted, id }

type: :file_deleted

Deleted object type.

For file deletion, this is always "file_deleted".

id: String

ID of the deleted file.

class 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: Time

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: Integer

Size of the file in bytes.

minimum0

downloadable: bool

Whether the file can be downloaded.

expires_at: Time

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