API Reference

App

Login

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Start Beeper app setup

client.app.login.start(RequestOptionsoptions?): LoginStartResponse { setupRequestID, signInMethods }

POST/v1/app/setup/start

Start setting up Beeper Desktop or Beeper Server. The flow supports existing Beeper accounts and new account creation.

ReturnsExpand Collapse

LoginStartResponse { setupRequestID, signInMethods }

setupRequestID: string

Setup request ID to use in the next sign-in step.

signInMethods: Array<string>

Available sign-in methods for this setup request.

Start Beeper app setup

TypeScript

HTTP

TypeScript

Python

Go

CLI Tool

PHP

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

const client = new BeeperDesktop();

const response = await client.app.login.start();

console.log(response.setupRequestID);

200 example

{
  "setupRequestID": "setupRequestID",
  "signInMethods": [
    "string"
  ]
}

Returns Examples

200 example

{
  "setupRequestID": "setupRequestID",
  "signInMethods": [
    "string"
  ]
}