Skip to content
Beeper Developer Docs
Download Beeper
API Reference

Assets

Manage assets in Beeper Desktop, like message attachments

Download an asset
client.assets.download(AssetDownloadParams { url } body, RequestOptionsoptions?): AssetDownloadResponse { error, srcURL }
POST/v1/assets/download
Upload an asset
client.assets.upload(AssetUploadParams { file, fileName, mimeType } body, RequestOptionsoptions?): AssetUploadResponse { duration, error, fileName, 6 more }
POST/v1/assets/upload
Upload an asset (base64)
client.assets.uploadBase64(AssetUploadBase64Params { content, fileName, mimeType } body, RequestOptionsoptions?): AssetUploadBase64Response { duration, error, fileName, 6 more }
POST/v1/assets/upload/base64
Serve an asset
client.assets.serve(AssetServeParams { url } query, RequestOptionsoptions?): void
GET/v1/assets/serve
ModelsExpand Collapse
AssetDownloadResponse { error, srcURL }
error?: string

Error message if the download failed.

srcURL?: string

Local file URL to the downloaded asset.

AssetUploadResponse { duration, error, fileName, 6 more }
duration?: number

Duration in seconds (audio/videos)

error?: string

Error message if upload failed

fileName?: string

Resolved filename

fileSize?: number

File size in bytes

height?: number

Height in pixels (images/videos)

mimeType?: string

Detected or provided MIME type

srcURL?: string

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

uploadID?: string

Unique upload ID for this asset

width?: number

Width in pixels (images/videos)

AssetUploadBase64Response { duration, error, fileName, 6 more }
duration?: number

Duration in seconds (audio/videos)

error?: string

Error message if upload failed

fileName?: string

Resolved filename

fileSize?: number

File size in bytes

height?: number

Height in pixels (images/videos)

mimeType?: string

Detected or provided MIME type

srcURL?: string

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

uploadID?: string

Unique upload ID for this asset

width?: number

Width in pixels (images/videos)