API Reference

Chats

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create or start a chat

$ beeper-desktop-cli chats create

POST/v1/chats

Create a single/group chat (mode=‘create’) or start a direct chat from merged user data (mode=‘start’).

ParametersExpand Collapse

--params: optional object { accountID, mode, user, 2 more } or object { accountID, participantIDs, type, 3 more }

ReturnsExpand Collapse

ChatNewResponse: object { chatID, status }

chatID: string

Newly created chat ID.

status: optional "existing" or "created"

Only returned in start mode. ‘existing’ means an existing chat was reused; ‘created’ means a new chat was created.

"existing"

"created"

Create or start a chat

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

PHP

beeper-desktop-cli chats create \
  --access-token 'My Access Token'

200 example

{
  "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com",
  "status": "existing"
}

Returns Examples

200 example

{
  "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com",
  "status": "existing"
}