Beeper Server API
Server discovery and capability metadata. Use /v1/info before authentication setup.
Server discovery and capability metadata. Use /v1/info before authentication setup.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/beeper-server-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Beeper Desktop Server API
version: 5.0.0
description: Beeper Desktop's local HTTP and WebSocket API.
termsOfService: https://www.beeper.com/terms
contact:
name: Beeper
email: help@beeper.com
url: https://www.beeper.com
license:
name: Proprietary
url: https://www.beeper.com/terms
servers:
- url: http://localhost:23373
description: Beeper Desktop API server
security:
- bearerAuth: []
tags:
- name: Server
description: Server discovery and capability metadata. Use /v1/info before authentication setup.
paths:
/v1/info:
get:
summary: Retrieve server info
description: Returns app, platform, server, endpoint discovery, OAuth, and WebSocket metadata for this Beeper Desktop instance.
tags:
- Server
operationId: getInfo
security: []
responses:
'200':
description: Beeper Desktop API server info
headers:
X-Beeper-Desktop-Version:
$ref: '#/components/headers/X-Beeper-Desktop-Version'
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectInfoOutput'
'500':
$ref: '#/components/responses/InternalServerError'
components:
schemas:
Error:
type: object
properties:
message:
type: string
description: Error message
code:
type: string
description: Machine-readable error code
details:
anyOf:
- type: object
properties:
issues:
type: array
items:
type: object
properties:
code:
type: string
description: Validation issue code
example: invalid_type
message:
type: string
description: Human-readable description of the validation issue
path:
type: array
items:
anyOf:
- type: string
x-stainless-variantName: field
- type: number
x-stainless-variantName: index
description: Path pointing to the invalid field within the payload
example:
- body
- chatID
required:
- code
- message
- path
description: List of validation issues
required:
- issues
description: Validation error details
x-stainless-variantName: validation_details
- type: object
additionalProperties:
nullable: true
x-stainless-any: true
description: Additional error context
x-stainless-variantName: context
- nullable: true
description: Arbitrary details payload supplied by the server
x-stainless-any: true
x-stainless-variantName: arbitrary
- nullable: true
description: Additional error details for debugging
required:
- message
- code
ConnectInfoOutput:
type: object
properties:
app:
type: object
properties:
name:
type: string
description: App name
version:
type: string
description: App version
bundle_id:
type: string
description: App bundle identifier
required:
- name
- version
- bundle_id
platform:
type: object
properties:
os:
type: string
description: Operating system identifier
arch:
type: string
description: CPU architecture
release:
type: string
description: Runtime release version
required:
- os
- arch
server:
type: object
properties:
status:
type: string
description: Server status
base_url:
type: string
description: Base URL of the Beeper Desktop API server
port:
type: integer
description: Listening port
hostname:
type: string
description: Listening host
remote_access:
type: boolean
description: Whether remote access is enabled
mcp_enabled:
type: boolean
description: Whether MCP endpoint is enabled
required:
- status
- base_url
- port
- hostname
- remote_access
- mcp_enabled
endpoints:
type: object
properties:
oauth:
type: object
properties:
authorization_endpoint:
type: string
description: OAuth authorization endpoint
token_endpoint:
type: string
description: OAuth token endpoint
introspection_endpoint:
type: string
description: OAuth introspection endpoint
userinfo_endpoint:
type: string
description: OAuth userinfo endpoint
revocation_endpoint:
type: string
description: OAuth token revocation endpoint
registration_endpoint:
type: string
description: OAuth dynamic client registration endpoint
required:
- authorization_endpoint
- token_endpoint
- introspection_endpoint
- userinfo_endpoint
- revocation_endpoint
- registration_endpoint
spec:
type: string
description: OpenAPI spec endpoint
mcp:
type: string
description: MCP endpoint
ws_events:
type: string
description: WebSocket events endpoint
required:
- oauth
- spec
- mcp
- ws_events
required:
- app
- platform
- server
- endpoints
headers:
X-Beeper-Desktop-Version:
description: Beeper Desktop application version providing this response.
schema:
type: string
example: 4.0.0
responses:
InternalServerError:
description: Internal server error
headers:
X-Beeper-Desktop-Version:
$ref: '#/components/headers/X-Beeper-Desktop-Version'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Bearer token authentication. Access token obtained via OAuth2 PKCE flow or created in-app. Required for all API operations.
oauth2:
type: oauth2
description: OAuth2 Authorization Code flow with PKCE for obtaining bearer access tokens. Used by MCP servers to authenticate clients.
flows:
authorizationCode:
authorizationUrl: http://localhost:23373/oauth/authorize
tokenUrl: http://localhost:23373/oauth/token
scopes:
read: Read access to messages, chats, and accounts
write: Write access to send messages, edit messages, react to messages, archive chats, and set reminders
externalDocs:
description: Beeper Desktop API Documentation
url: https://developers.beeper.com/desktop-api