How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Beeper

Beeper Chats API

Chats, reminders, read state, archive state, priority, mute, and other conversation metadata.

Documentation Provider Profile APIs.io OpenAPI GitHub

Beeper Chats API is one of 7 APIs that Beeper publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Chats. The published artifact set on APIs.io includes an OpenAPI specification and an AsyncAPI specification.

This API exposes 12 operations across 9 paths, and defines 29 schemas. It is described by OpenAPI 3.1.0, at version 5.0.0.

Requests are made against a single base URL, http://localhost:23373.

12 operations 9 paths 29 schemas 1 DELETE3 GET1 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
5.0.0
Base URL
http://localhost:23373
Authentication
HTTP Bearer, OAuth 2.0
Contact
Beeper
License
Proprietary
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Beeper Chats API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication. Access token obtained via OAuth2 PKCE flow or created in-app. Required for all API operations.
  • oauth2 — OAuth2 Authorization Code flow with PKCE for obtaining bearer access tokens. Used by MCP servers to authenticate clients.

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 1 DELETE, 3 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Chats 12

Chats, reminders, read state, archive state, priority, mute, and other conversation metadata.

GET
/v1/chats/search
Search chats
searchChats 12 params → 200400401403404422429500
GET
/v1/chats
List chats
listChats 3 params → 200400401403404422429500
POST
/v1/chats
Create a chat
createChat body → 200400401403404422429500
POST
/v1/chats/start
Start a direct chat
startChat body → 200400401403404422429500
GET
/v1/chats/{chatID}
Retrieve chat details
getChat 2 params → 200400401403404422429500
PATCH
/v1/chats/{chatID}
Update chat
patchChat 1 param body → 200400401403404422429500
POST
/v1/chats/{chatID}/archive
Archive or unarchive a chat
archiveChat 1 param body → 204400401403404422429500
POST
/v1/chats/{chatID}/reminders
Create a chat reminder
setChatReminder 1 param body → 204400401403404422429500
DELETE
/v1/chats/{chatID}/reminders
Delete a chat reminder
clearChatReminder 1 param → 204400401403404422429500
POST
/v1/chats/{chatID}/read
Mark a chat as read
markChatRead 1 param body → 200400401403404422429500
POST
/v1/chats/{chatID}/unread
Mark a chat as unread
markChatUnread 1 param body → 200400401403404422429500
POST
/v1/chats/{chatID}/notify-anyway
Notify anyway
notifyAnyway 1 param body → 200400401403404422429500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are ChatCapabilities (27 properties), Chat (24 properties), Message (21 properties), Attachment (13 properties). Each schema is shown below with its type and property counts.

DraftAttachmentInput
Message
object
21 properties 6 required
SearchChatsOutput
object
4 properties 4 required
User
object
User the account belongs to.
8 properties 1 required
LinkPreview
object
Link preview included with a message.
7 properties 2 required
AttachmentCapabilities
object
Capabilities for one attachment message type.
8 properties 1 required
Chat
object
24 properties 7 required
Error
object
3 properties 2 required
ChatDraftInput
object
Draft object to set or clear. Non-empty drafts are only accepted when the current draft is empty. Send draft=null to clear text and attachments together before…
2 properties 1 required
CreateChatOutput
ChatStateCapabilities
object
Chat state update capabilities.
4 properties
MessageSeen
Read receipt state for this message, when available.
MessageSeenByParticipant
object
Group read receipt state keyed by participant ID.
SendStatus
object
Message send status for this message, when reported by the bridge.
6 properties 2 required
ChatCapabilities
object
Chat capabilities reported by the platform.
27 properties
StartChatInput
object
Start a direct chat from a user/contact payload. Available in Beeper Desktop v4.2.808+.
4 properties 2 required
MessageTextInput
string
Draft text. Plain text and Markdown are converted to Matrix HTML with the same rules used by send and edit.
ChatWithPreview
Chat with optional last message preview.
DraftAttachment
object
9 properties 2 required
MessageAttachmentInput
object
6 properties 1 required
Attachment
object
13 properties 1 required
CreateChatInput
object
5 properties 3 required
MessageAttachmentType
string
Attachment type hint (image, video, audio, file, gif, voice-note, sticker). If omitted, auto-detected from mimeType
Transcription
object
Attachment transcription if available.
3 properties 2 required
ListChatsOutput
object
4 properties 4 required
Reaction
object
5 properties 3 required
ChatDraft
object
Current draft object for this chat, or null when no draft is set.
2 properties 1 required
Participant
A chat participant. Extends User with chat membership metadata.
CapabilitySupportLevel
integer
-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beeper-chats-api-openapi.yml Raw ↑

Other APIs Beeper publishes across the network.

Beeper Accounts API
AE Profile APIs.io
Beeper App API
AE Profile APIs.io
Beeper Contacts API
AE Profile APIs.io
Beeper Files API
AE Profile APIs.io
Beeper Messages API
AE Profile APIs.io
Beeper Server API
AE Profile APIs.io
#Chats
← Back to B APIs
API Details
ID
beeper:beeper-chats-api
Base URL
http://localhost:23373
Docs
https://developers.beeper.com/desktop-api/
Provider
Beeper
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=beeper-chats-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/beeper-chats-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Beeper Chats API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.