API Reference
Libraries
CLI tool
0.1.0
<!-- x-release-please-start-version --> ## Installation ### Installing with Homebrew ~~~sh brew tap beeper/tap brew install beeper-desktop-cli ~~~ ### Installing with Go To test or install the CLI locally, you need [Go](https://go.dev/doc/install) version 1.22 or later installed. ~~~sh go install 'github.com/beeper/desktop-api-cli/cmd/beeper-desktop-cli@latest' ~~~ Once you have run `go install`, the binary is placed in your Go bin directory: - **Default location**: `$HOME/go/bin` (or `$GOPATH/bin` if GOPATH is set) - **Check your path**: Run `go env GOPATH` to see the base directory If commands aren't found after installation, add the Go bin directory to your PATH: ~~~sh # Add to your shell profile (.zshrc, .bashrc, etc.) export PATH="$PATH:$(go env GOPATH)/bin" ~~~ <!-- x-release-please-end -->
API Overview
Accounts
Manage connected chat accounts
List connected accounts
GET/v1/accounts
AccountsContacts
Manage contacts on a specific account
Search contacts
GET/v1/accounts/{accountID}/contacts
List contacts
GET/v1/accounts/{accountID}/contacts/list
Chats
Manage chats
Retrieve chat details
GET/v1/chats/{chatID}
Create or start a chat
POST/v1/chats
List chats
GET/v1/chats
Search chats
GET/v1/chats/search
Archive or unarchive a chat
POST/v1/chats/{chatID}/archive
ChatsReminders
Manage reminders for chats
Create a chat reminder
POST/v1/chats/{chatID}/reminders
Delete a chat reminder
DELETE/v1/chats/{chatID}/reminders
ChatsMessages
Manage chat messages
ChatsMessagesReactions
Manage message reactions
Add a reaction
POST/v1/chats/{chatID}/messages/{messageID}/reactions
Remove a reaction
DELETE/v1/chats/{chatID}/messages/{messageID}/reactions
Messages
Manage messages in chats
Search messages
GET/v1/messages/search
List messages
GET/v1/chats/{chatID}/messages
Send a message
POST/v1/chats/{chatID}/messages
Edit a message
PUT/v1/chats/{chatID}/messages/{messageID}
Assets
Manage assets in Beeper Desktop, like message attachments
Download an asset
POST/v1/assets/download
Upload an asset
POST/v1/assets/upload
Upload an asset (base64)
POST/v1/assets/upload/base64
Serve an asset
GET/v1/assets/serve
Info
Get Connect server info
GET/v1/info