API Reference

Assets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Upload an asset

$ beeper-desktop-cli assets upload

POST/v1/assets/upload

Upload a file to a temporary location using multipart/form-data. Returns an uploadID that can be referenced when sending messages with attachments.

ParametersExpand Collapse

--file: file path

The file to upload (max 500 MB).

--file-name: optional string

Original filename. Defaults to the uploaded file name if omitted

--mime-type: optional string

MIME type. Auto-detected from magic bytes if omitted

ReturnsExpand Collapse

AssetUploadResponse: object { duration, error, fileName, 6 more }

duration: optional number

Duration in seconds (audio/videos)

error: optional string

Error message if upload failed

fileName: optional string

Resolved filename

fileSize: optional number

File size in bytes

height: optional number

Height in pixels (images/videos)

mimeType: optional string

Detected or provided MIME type

srcURL: optional string

Local file URL (file://) for the uploaded asset

uploadID: optional string

Unique upload ID for this asset

width: optional number

Width in pixels (images/videos)

Upload an asset

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

PHP

beeper-desktop-cli assets upload \
  --access-token 'My Access Token' \
  --file 'Example data'

200 example

{
  "duration": 0,
  "error": "error",
  "fileName": "fileName",
  "fileSize": 0,
  "height": 0,
  "mimeType": "mimeType",
  "srcURL": "srcURL",
  "uploadID": "uploadID",
  "width": 0
}

Returns Examples

200 example

{
  "duration": 0,
  "error": "error",
  "fileName": "fileName",
  "fileSize": 0,
  "height": 0,
  "mimeType": "mimeType",
  "srcURL": "srcURL",
  "uploadID": "uploadID",
  "width": 0
}