API Reference

Chats

Create a chat

chats.create(ChatCreateParams**kwargs) -> ChatCreateResponse

post/v1/chats

Create a single or group chat on a specific account using participant IDs and optional title.

ParametersExpand Collapse

account_id: str

Account to create the chat on.

participant_ids: SequenceNotStr[str]

User IDs to include in the new chat.

type: Literal["single", "group"]

Chat type to create: 'single' requires exactly one participantID; 'group' supports multiple participants and optional title.

Accepts one of the following:

"single"

"group"

message_text: Optional[str]

Optional first message content if the platform requires it to create the chat.

title: Optional[str]

Optional title for group chats; ignored for single chats on most platforms.

ReturnsExpand Collapse

class ChatCreateResponse: …

chat_id: str

Newly created chat ID.

Create a chat

Python

HTTP

TypeScript

Python

Go

from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token="My Access Token",
)
chat = client.chats.create(
    account_id="accountID",
    participant_ids=["string"],
    type="single",
)
print(chat.chat_id)

200 example

{
  "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com"
}

Returns Examples

200 example

{
  "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com"
}