API Reference

Assets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Download a file

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.

Body ParametersJSONExpand Collapse

url: string

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

minLength1

ReturnsExpand Collapse

error: optional string

Error message if the download failed.

srcURL: optional string

Local file URL to the downloaded file.

Download a file

HTTP

HTTP

TypeScript

Python

Go

CLI Tool

PHP

curl http://localhost:23373/v1/assets/download \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN" \
    -d '{
          "url": "mxc://example.org/Q4x9CqGz1pB3Oa6XgJ"
        }'

200 example

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

Returns Examples

200 example

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