Skip to content
Beeper Developer Docs
Download Beeper
API Reference
Overview

API Reference

Libraries

TypeScript
5.0.0
npm install @beeper/desktop-api
Read Docs
Python
5.0.0
pip install git+ssh://git@github.com/beeper/desktop-api-python.git
Read Docs
Go
5.0.0
go get -u 'github.com/beeper/desktop-api-go@v5.0.0'
Read Docs
CLI tool
0.3.0
 
Read Docs
PHP
0.0.1
composer require "beeper/desktop-api-php 0.0.1"
 
Read Docs
 
  
API Overview
 
 
Accounts
Manage connected chat accounts
List chat accounts
GET/v1/accounts
Get chat account
GET/v1/accounts/{accountID}
AccountsContacts
Manage contacts on a specific account
Search contacts
GET/v1/accounts/{accountID}/contacts
List contacts
GET/v1/accounts/{accountID}/contacts/list
Bridges
Manage bridge-backed account types, connections, and login sessions
List available bridges
GET/v1/bridges
Get bridge
GET/v1/bridges/{bridgeID}
Get bridge capabilities
GET/v1/bridges/{bridgeID}/capabilities
BridgesLogin Flows
Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities.
List login flows
GET/v1/bridges/{bridgeID}/login-flows
BridgesConnections
BridgesLogin Sessions
Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities.
Create bridge login session
POST/v1/bridges/{bridgeID}/login-sessions
Get bridge login session
GET/v1/bridges/{bridgeID}/login-sessions/{loginSessionID}
Cancel bridge login session
DELETE/v1/bridges/{bridgeID}/login-sessions/{loginSessionID}
BridgesLogin SessionsSteps
Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities.
Submit login step
POST/v1/bridges/{bridgeID}/login-sessions/{loginSessionID}/steps/{stepID}
Chats
Manage chats
Retrieve chat details
GET/v1/chats/{chatID}
Create a chat
POST/v1/chats
Start a direct chat
POST/v1/chats/start
List chats
GET/v1/chats
Search chats
GET/v1/chats/search
Archive or unarchive a chat
POST/v1/chats/{chatID}/archive
Update chat
PATCH/v1/chats/{chatID}
Mark a chat as read
POST/v1/chats/{chatID}/read
Mark a chat as unread
POST/v1/chats/{chatID}/unread
Notify anyway
POST/v1/chats/{chatID}/notify-anyway
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/{reactionKey}
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
Retrieve a message
GET/v1/chats/{chatID}/messages/{messageID}
Edit a message
PUT/v1/chats/{chatID}/messages/{messageID}
Delete a message
DELETE/v1/chats/{chatID}/messages/{messageID}
Assets
Manage assets in Beeper Desktop, like message attachments
Download a file
POST/v1/assets/download
Upload a file
POST/v1/assets/upload
Upload a file (base64)
POST/v1/assets/upload/base64
Serve a file
GET/v1/assets/serve
Info
Server discovery and capability metadata. Use /v1/info before authentication setup.
Retrieve server info
GET/v1/info
App
Manage Beeper app login and encrypted messaging setup
Get Beeper app setup state
GET/v1/app/setup
AppLogin
Complete first-party Beeper app login
Start Beeper app setup
POST/v1/app/setup/start
Send setup sign-in code
POST/v1/app/setup/email
Complete setup sign-in with code
POST/v1/app/setup/response
Create account for setup
POST/v1/app/setup/register
AppLoginVerification
AppLoginVerificationRecovery Key
First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.
Verify with recovery key
POST/v1/app/setup/verification/recovery-key
AppLoginVerificationRecovery KeyReset
First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.
Create new recovery key
POST/v1/app/setup/verification/recovery-key/reset
Confirm new recovery key
POST/v1/app/setup/verification/recovery-key/reset/confirm
AppVerifications
Manage device verification transactions
List active verifications
GET/v1/app/setup/verifications
Start device verification
POST/v1/app/setup/verifications
Get verification
GET/v1/app/setup/verifications/{verificationID}
Accept device verification
POST/v1/app/setup/verifications/{verificationID}/accept
Cancel device verification
POST/v1/app/setup/verifications/{verificationID}/cancel
AppVerificationsQr
First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.
Scan verification QR code
POST/v1/app/setup/verifications/qr/scan
Confirm QR code scan
POST/v1/app/setup/verifications/{verificationID}/qr/confirm-scanned
AppVerificationsSAS
First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.
Start emoji verification
POST/v1/app/setup/verifications/{verificationID}/sas/start
Confirm emoji verification
POST/v1/app/setup/verifications/{verificationID}/sas/confirm