Skip to content
  • Auto
  • Light
  • Dark
Download Beeper

Download Asset

Download an asset
post/v1/download-asset

Download a Matrix asset using its mxc:// or localmxc:// URL and return the local file URL.

Body ParametersExpand Collapse
url: string

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

minLength1
ReturnsExpand Collapse
error: optional string

Error message if the download failed.

srcURL: optional string

Local file URL to the downloaded asset.

Download an asset
curl http://localhost:23373/v1/download-asset \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN" \
    -d '{
          "url": "mxc://example.org/Q4x9CqGz1pB3Oa6XgJ"
        }'
{
  "error": "error",
  "srcURL": "srcURL"
}
Returns Examples
{
  "error": "error",
  "srcURL": "srcURL"
}