Upload an asset

POST/v1/assets/upload

Upload a file to a temporary location using multipart/form-data. Returns an uploadID that can be referenced when sending messages with attachments.

ParametersExpand Collapse

file: FileTypes

The file to upload (max 500 MB).

file_name: Optional[str]

Original filename. Defaults to the uploaded file name if omitted

mime_type: Optional[str]

MIME type. Auto-detected from magic bytes if omitted

ReturnsExpand Collapse

class AssetUploadResponse: …

duration: Optional[float]

Duration in seconds (audio/videos)

error: Optional[str]

Error message if upload failed

file_name: Optional[str]

Resolved filename

file_size: Optional[float]

File size in bytes

height: Optional[float]

Height in pixels (images/videos)

mime_type: Optional[str]

Detected or provided MIME type

src_url: Optional[str]

Local file URL (file://) for the uploaded asset

upload_id: Optional[str]

Unique upload ID for this asset

width: Optional[float]

Width in pixels (images/videos)

Upload an asset

from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop()
response = client.assets.upload(
    file=b"raw file contents",
)
print(response.width)

{
  "duration": 0,
  "error": "error",
  "fileName": "fileName",
  "fileSize": 0,
  "height": 0,
  "mimeType": "mimeType",
  "srcURL": "srcURL",
  "uploadID": "uploadID",
  "width": 0
}

Returns Examples

{
  "duration": 0,
  "error": "error",
  "fileName": "fileName",
  "fileSize": 0,
  "height": 0,
  "mimeType": "mimeType",
  "srcURL": "srcURL",
  "uploadID": "uploadID",
  "width": 0
}