Get Connect server info

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

GET/v1/info

Returns app, platform, server, and endpoint discovery metadata for this Beeper Desktop instance.

ReturnsExpand 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 Connect 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

Get Connect server info

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop();

const info = await client.info.retrieve();

console.log(info.app);

{
  "app": {
    "bundle_id": "bundle_id",
    "name": "name",
    "version": "version"
  },
  "endpoints": {
    "mcp": "mcp",
    "oauth": {
      "authorization_endpoint": "authorization_endpoint",
      "introspection_endpoint": "introspection_endpoint",
      "registration_endpoint": "registration_endpoint",
      "revocation_endpoint": "revocation_endpoint",
      "token_endpoint": "token_endpoint",
      "userinfo_endpoint": "userinfo_endpoint"
    },
    "spec": "spec",
    "ws_events": "ws_events"
  },
  "platform": {
    "arch": "arch",
    "os": "os",
    "release": "release"
  },
  "server": {
    "base_url": "base_url",
    "hostname": "hostname",
    "mcp_enabled": true,
    "port": 0,
    "remote_access": true,
    "status": "status"
  }
}

Returns Examples

{
  "app": {
    "bundle_id": "bundle_id",
    "name": "name",
    "version": "version"
  },
  "endpoints": {
    "mcp": "mcp",
    "oauth": {
      "authorization_endpoint": "authorization_endpoint",
      "introspection_endpoint": "introspection_endpoint",
      "registration_endpoint": "registration_endpoint",
      "revocation_endpoint": "revocation_endpoint",
      "token_endpoint": "token_endpoint",
      "userinfo_endpoint": "userinfo_endpoint"
    },
    "spec": "spec",
    "ws_events": "ws_events"
  },
  "platform": {
    "arch": "arch",
    "os": "os",
    "release": "release"
  },
  "server": {
    "base_url": "base_url",
    "hostname": "hostname",
    "mcp_enabled": true,
    "port": 0,
    "remote_access": true,
    "status": "status"
  }
}