API Reference

Assets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Serve an asset

client.assets.serve(AssetServeParams { url } query, RequestOptionsoptions?): void

GET/v1/assets/serve

Stream a file given an mxc://, localmxc://, or file:// URL. Downloads first if not cached. Supports Range requests for seeking in large files.

ParametersExpand Collapse

query: AssetServeParams { url }

url: string

Asset URL to serve. Accepts mxc://, localmxc://, or file:// URLs.

minLength1

Serve an asset

TypeScript

HTTP

TypeScript

Python

Go

CLI Tool

PHP

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: process.env['BEEPER_ACCESS_TOKEN'], // This is the default and can be omitted
});

await client.assets.serve({ url: 'x' });

Returns Examples