API Reference

Assets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Download a file

$ beeper-desktop assets download

POST/v1/assets/download

Download a file from an mxc:// or localmxc:// URL to the device running the Beeper Client API and return the local file URL.

ParametersExpand Collapse

--url: string

Beeper media URL (mxc:// or localmxc://) for the file to download.

ReturnsExpand Collapse

AssetDownloadResponse: object { error, srcURL }

error: optional string

Error message if the download failed.

srcURL: optional string

Local file URL to the downloaded file.

Download a file

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

PHP

beeper-desktop assets download \
  --access-token 'My Access Token' \
  --url mxc://example.org/Q4x9CqGz1pB3Oa6XgJ

200 example

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

Returns Examples

200 example

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