API Reference

Assets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Download an asset

assets.download(AssetDownloadParams**kwargs) -> AssetDownloadResponse

POST/v1/assets/download

Download a Matrix asset using its mxc:// or localmxc:// URL to the device running Beeper Desktop and return the local file URL.

ParametersExpand Collapse

url: str

Matrix content URL (mxc:// or localmxc://) for the asset to download.

minLength1

ReturnsExpand Collapse

class AssetDownloadResponse: …

error: Optional[str]

Error message if the download failed.

src_url: Optional[str]

Local file URL to the downloaded asset.

Download an asset

Python

HTTP

TypeScript

Python

Go

CLI Tool

PHP

import os
from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
)
response = client.assets.download(
    url="mxc://example.org/Q4x9CqGz1pB3Oa6XgJ",
)
print(response.error)

200 example

{
  "error": "error",
  "srcURL": "srcURL"
}

Returns Examples

200 example

{
  "error": "error",
  "srcURL": "srcURL"
}