API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Info

Server discovery and capability metadata. Use /v1/info before authentication setup.

Retrieve server info

client.info.retrieve(RequestOptionsoptions?): InfoRetrieveResponse { app, endpoints, platform, server }

GET/v1/info

ModelsExpand Collapse

InfoRetrieveResponse { app, endpoints, platform, server }

app: App { bundle_id, name, version }

bundle_id: string

App bundle identifier

name: string

App name

version: string

App version

endpoints: Endpoints { mcp, oauth, spec, ws_events }

mcp: string

MCP endpoint

oauth: OAuth { authorization_endpoint, introspection_endpoint, registration_endpoint, 3 more }

authorization_endpoint: string

OAuth authorization endpoint

introspection_endpoint: string

OAuth introspection endpoint

registration_endpoint: string

OAuth dynamic client registration endpoint

revocation_endpoint: string

OAuth token revocation endpoint

token_endpoint: string

OAuth token endpoint

userinfo_endpoint: string

OAuth userinfo endpoint

spec: string

OpenAPI spec endpoint

ws_events: string

WebSocket events endpoint

platform: Platform { arch, os, release }

arch: string

CPU architecture

os: string

Operating system identifier

release?: string

Runtime release version

server: Server { base_url, hostname, mcp_enabled, 3 more }

base_url: string

Base URL of the Beeper Client API server

hostname: string

Listening host

mcp_enabled: boolean

Whether MCP endpoint is enabled

port: number

Listening port

remote_access: boolean

Whether remote access is enabled

status: string

Server status