API Reference

App

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Login

Complete first-party Beeper app login

Start Beeper app setup

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

POST/v1/app/setup/start

Send setup sign-in code

client.app.login.email(LoginEmailParams { email, setupRequestID } body, RequestOptionsoptions?): void

POST/v1/app/setup/email

Complete setup sign-in with code

client.app.login.response(LoginResponseParams { response, setupRequestID } body, RequestOptionsoptions?): LoginResponseResponse

POST/v1/app/setup/response

Create account for setup

client.app.login.register(LoginRegisterParams { acceptTerms, leadToken, setupRequestID, username } body, RequestOptionsoptions?): LoginRegisterResponse { matrix, session }

POST/v1/app/setup/register

ModelsExpand 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.

LoginResponseResponse = Success { matrix, session } | RegistrationRequired { copy, leadToken, registrationRequired, 2 more }

One of the following:

Success { matrix, session }

matrix: Matrix { accessToken, deviceID, homeserver, userID }

Account credentials for first-party app setup.

accessToken: string

Beeper account access token. Returned once for first-party app setup.

deviceID: string

Current device ID.

homeserver: string

Beeper homeserver URL for this account.

userID: string

Signed-in Beeper user ID.

session: Session { e2ee, state, matrix, verification }

Current app sign-in and encrypted messaging setup state after sign-in.

e2ee: E2EE { crossSigning, firstSyncDone, hasBackedUpRecoveryKey, 6 more }

Encrypted messaging setup status.

crossSigning: boolean

Whether this account can verify trusted devices.

firstSyncDone: boolean

Whether the first encrypted message sync is complete.

hasBackedUpRecoveryKey: boolean

Whether the user confirmed that they saved their recovery key.

initialized: boolean

Whether encrypted messaging setup has started.

keyBackup: boolean

Whether encrypted message backup is available.

secrets: Secrets { masterKey, megolmBackupKey, recoveryKey, 2 more }

Encrypted messaging keys available on this device.

masterKey: boolean

Whether the account identity key is available.

megolmBackupKey: boolean

Whether the encrypted message backup key is available.

recoveryKey: boolean

Whether a recovery key is available.

selfSigningKey: boolean

Whether the device trust key is available.

userSigningKey: boolean

Whether the user trust key is available.

secretStorage: boolean

Whether secure key storage is available.

verified: boolean

Whether this device is trusted for encrypted messages.

recoveryKeyGeneratedAt?: number

Unix timestamp for when the recovery key was created.

state: "needs-login" | "initializing" | "needs-cross-signing-setup" | 4 more

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

"needs-login"

"initializing"

"needs-cross-signing-setup"

"needs-verification"

"needs-secrets"

"needs-first-sync"

"ready"

matrix?: Matrix { deviceID, homeserver, userID }

Signed-in account details. Omitted until sign-in is complete.

deviceID: string

Current device ID.

homeserver: string

Beeper homeserver URL for this account.

userID: string

Signed-in Beeper user ID.

verification?: Verification { id, availableActions, direction, 8 more }

Trusted device verification progress.

id: string

Verification ID to pass in verification action paths.

availableActions: Array<"accept" | "cancel" | "qr.confirmScanned" | 2 more>

Verification actions that are valid for the current state.

One of the following:

"accept"

"cancel"

"qr.confirmScanned"

"sas.start"

"sas.confirm"

direction: "incoming" | "outgoing"

Whether this device started or received the verification.

One of the following:

"incoming"

"outgoing"

methods: Array<"qr" | "sas">

Verification methods supported for this transaction.

One of the following:

"qr"

"sas"

purpose: "login" | "device"

Why this verification exists.

One of the following:

"login"

"device"

state: "requested" | "ready" | "sas_ready" | 4 more

Current trusted-device verification state.

One of the following:

"requested"

"ready"

"sas_ready"

"qr_scanned"

"done"

"cancelled"

"error"

error?: Error { code, reason }

Verification error details, if verification stopped.

code: string

Verification error code.

reason: string

User-facing verification error message.

otherDevice?: OtherDevice { id, name }

Other device participating in verification.

id: string

Other device ID.

name?: string

Other device display name, if known.

otherUserID?: string

Other Beeper user participating in verification.

qr?: Qr { data }

QR verification data.

data: string

QR code payload to display for verification.

sas?: SAS { emojis, decimals }

Emoji or number comparison data for verification.

emojis: string

Emoji sequence to compare on both devices.

decimals?: string

Number sequence to compare on both devices.

RegistrationRequired { copy, leadToken, registrationRequired, 2 more }

copy: Copy { submit, terms, title, usernamePlaceholder }

Copy to display during account creation.

submit: "Continue"

Submit button label.

terms: "By continuing, you agree to the Terms of Use and acknowledge the Privacy Policy."

Terms and privacy notice to show before account creation.

title: "Choose your username"

Title for the username step.

usernamePlaceholder: "Username"

Placeholder for the username field.

leadToken: string

Registration token returned by Beeper.

registrationRequired: true

Indicates that the user needs to create a Beeper account.

setupRequestID: string

Setup request ID to use when creating the account.

usernameSuggestions?: Array<string>

Suggested usernames for the new account.

LoginRegisterResponse { matrix, session }

matrix: Matrix { accessToken, deviceID, homeserver, userID }

Account credentials for first-party app setup.

accessToken: string

Beeper account access token. Returned once for first-party app setup.

deviceID: string

Current device ID.

homeserver: string

Beeper homeserver URL for this account.

userID: string

Signed-in Beeper user ID.

session: Session { e2ee, state, matrix, verification }

Current app sign-in and encrypted messaging setup state after sign-in.

e2ee: E2EE { crossSigning, firstSyncDone, hasBackedUpRecoveryKey, 6 more }

Encrypted messaging setup status.

crossSigning: boolean

Whether this account can verify trusted devices.

firstSyncDone: boolean

Whether the first encrypted message sync is complete.

hasBackedUpRecoveryKey: boolean

Whether the user confirmed that they saved their recovery key.

initialized: boolean

Whether encrypted messaging setup has started.

keyBackup: boolean

Whether encrypted message backup is available.

secrets: Secrets { masterKey, megolmBackupKey, recoveryKey, 2 more }

Encrypted messaging keys available on this device.

masterKey: boolean

Whether the account identity key is available.

megolmBackupKey: boolean

Whether the encrypted message backup key is available.

recoveryKey: boolean

Whether a recovery key is available.

selfSigningKey: boolean

Whether the device trust key is available.

userSigningKey: boolean

Whether the user trust key is available.

secretStorage: boolean

Whether secure key storage is available.

verified: boolean

Whether this device is trusted for encrypted messages.

recoveryKeyGeneratedAt?: number

Unix timestamp for when the recovery key was created.

state: "needs-login" | "initializing" | "needs-cross-signing-setup" | 4 more

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

"needs-login"

"initializing"

"needs-cross-signing-setup"

"needs-verification"

"needs-secrets"

"needs-first-sync"

"ready"

matrix?: Matrix { deviceID, homeserver, userID }

Signed-in account details. Omitted until sign-in is complete.

deviceID: string

Current device ID.

homeserver: string

Beeper homeserver URL for this account.

userID: string

Signed-in Beeper user ID.

verification?: Verification { id, availableActions, direction, 8 more }

Trusted device verification progress.

id: string

Verification ID to pass in verification action paths.

availableActions: Array<"accept" | "cancel" | "qr.confirmScanned" | 2 more>

Verification actions that are valid for the current state.

One of the following:

"accept"

"cancel"

"qr.confirmScanned"

"sas.start"

"sas.confirm"

direction: "incoming" | "outgoing"

Whether this device started or received the verification.

One of the following:

"incoming"

"outgoing"

methods: Array<"qr" | "sas">

Verification methods supported for this transaction.

One of the following:

"qr"

"sas"

purpose: "login" | "device"

Why this verification exists.

One of the following:

"login"

"device"

state: "requested" | "ready" | "sas_ready" | 4 more

Current trusted-device verification state.

One of the following:

"requested"

"ready"

"sas_ready"

"qr_scanned"

"done"

"cancelled"

"error"

error?: Error { code, reason }

Verification error details, if verification stopped.

code: string

Verification error code.

reason: string

User-facing verification error message.

otherDevice?: OtherDevice { id, name }

Other device participating in verification.

id: string

Other device ID.

name?: string

Other device display name, if known.

otherUserID?: string

Other Beeper user participating in verification.

qr?: Qr { data }

QR verification data.

data: string

QR code payload to display for verification.

sas?: SAS { emojis, decimals }

Emoji or number comparison data for verification.

emojis: string

Emoji sequence to compare on both devices.

decimals?: string

Number sequence to compare on both devices.

LoginVerification

LoginVerificationRecovery Key

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Verify with recovery key

client.app.login.verification.recoveryKey.verify(RecoveryKeyVerifyParams { recoveryKey } body, RequestOptionsoptions?): RecoveryKeyVerifyResponse { session }

POST/v1/app/setup/verification/recovery-key

ModelsExpand Collapse

RecoveryKeyVerifyResponse { session }

session: Session { e2ee, state, matrix, verification }

Current app sign-in and encrypted messaging setup state.

e2ee: E2EE { crossSigning, firstSyncDone, hasBackedUpRecoveryKey, 6 more }

Encrypted messaging setup status.

crossSigning: boolean

Whether this account can verify trusted devices.

firstSyncDone: boolean

Whether the first encrypted message sync is complete.

hasBackedUpRecoveryKey: boolean

Whether the user confirmed that they saved their recovery key.

initialized: boolean

Whether encrypted messaging setup has started.

keyBackup: boolean

Whether encrypted message backup is available.

secrets: Secrets { masterKey, megolmBackupKey, recoveryKey, 2 more }

Encrypted messaging keys available on this device.

masterKey: boolean

Whether the account identity key is available.

megolmBackupKey: boolean

Whether the encrypted message backup key is available.

recoveryKey: boolean

Whether a recovery key is available.

selfSigningKey: boolean

Whether the device trust key is available.

userSigningKey: boolean

Whether the user trust key is available.

secretStorage: boolean

Whether secure key storage is available.

verified: boolean

Whether this device is trusted for encrypted messages.

recoveryKeyGeneratedAt?: number

Unix timestamp for when the recovery key was created.

state: "needs-login" | "initializing" | "needs-cross-signing-setup" | 4 more

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

"needs-login"

"initializing"

"needs-cross-signing-setup"

"needs-verification"

"needs-secrets"

"needs-first-sync"

"ready"

matrix?: Matrix { deviceID, homeserver, userID }

Signed-in account details. Omitted until sign-in is complete.

deviceID: string

Current device ID.

homeserver: string

Beeper homeserver URL for this account.

userID: string

Signed-in Beeper user ID.

verification?: Verification { id, availableActions, direction, 8 more }

Trusted device verification progress.

id: string

Verification ID to pass in verification action paths.

availableActions: Array<"accept" | "cancel" | "qr.confirmScanned" | 2 more>

Verification actions that are valid for the current state.

One of the following:

"accept"

"cancel"

"qr.confirmScanned"

"sas.start"

"sas.confirm"

direction: "incoming" | "outgoing"

Whether this device started or received the verification.

One of the following:

"incoming"

"outgoing"

methods: Array<"qr" | "sas">

Verification methods supported for this transaction.

One of the following:

"qr"

"sas"

purpose: "login" | "device"

Why this verification exists.

One of the following:

"login"

"device"

state: "requested" | "ready" | "sas_ready" | 4 more

Current trusted-device verification state.

One of the following:

"requested"

"ready"

"sas_ready"

"qr_scanned"

"done"

"cancelled"

"error"

error?: Error { code, reason }

Verification error details, if verification stopped.

code: string

Verification error code.

reason: string

User-facing verification error message.

otherDevice?: OtherDevice { id, name }

Other device participating in verification.

id: string

Other device ID.

name?: string

Other device display name, if known.

otherUserID?: string

Other Beeper user participating in verification.

qr?: Qr { data }

QR verification data.

data: string

QR code payload to display for verification.

sas?: SAS { emojis, decimals }

Emoji or number comparison data for verification.

emojis: string

Emoji sequence to compare on both devices.

decimals?: string

Number sequence to compare on both devices.

LoginVerificationRecovery KeyReset

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Create new recovery key

client.app.login.verification.recoveryKey.reset.create(ResetCreateParams { existingRecoveryKey } body?, RequestOptionsoptions?): ResetCreateResponse { recoveryKey, session }

POST/v1/app/setup/verification/recovery-key/reset

Confirm new recovery key

client.app.login.verification.recoveryKey.reset.confirm(ResetConfirmParams { recoveryKey } body, RequestOptionsoptions?): ResetConfirmResponse { session }

POST/v1/app/setup/verification/recovery-key/reset/confirm

ModelsExpand Collapse

ResetCreateResponse { recoveryKey, session }

recoveryKey: string

New recovery key. Show it once and ask the user to save it.

session: Session { e2ee, state, matrix, verification }

Current app sign-in and encrypted messaging setup state after creating the new recovery key.

e2ee: E2EE { crossSigning, firstSyncDone, hasBackedUpRecoveryKey, 6 more }

Encrypted messaging setup status.

crossSigning: boolean

Whether this account can verify trusted devices.

firstSyncDone: boolean

Whether the first encrypted message sync is complete.

hasBackedUpRecoveryKey: boolean

Whether the user confirmed that they saved their recovery key.

initialized: boolean

Whether encrypted messaging setup has started.

keyBackup: boolean

Whether encrypted message backup is available.

secrets: Secrets { masterKey, megolmBackupKey, recoveryKey, 2 more }

Encrypted messaging keys available on this device.

masterKey: boolean

Whether the account identity key is available.

megolmBackupKey: boolean

Whether the encrypted message backup key is available.

recoveryKey: boolean

Whether a recovery key is available.

selfSigningKey: boolean

Whether the device trust key is available.

userSigningKey: boolean

Whether the user trust key is available.

secretStorage: boolean

Whether secure key storage is available.

verified: boolean

Whether this device is trusted for encrypted messages.

recoveryKeyGeneratedAt?: number

Unix timestamp for when the recovery key was created.

state: "needs-login" | "initializing" | "needs-cross-signing-setup" | 4 more

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

"needs-login"

"initializing"

"needs-cross-signing-setup"

"needs-verification"

"needs-secrets"

"needs-first-sync"

"ready"

matrix?: Matrix { deviceID, homeserver, userID }

Signed-in account details. Omitted until sign-in is complete.

deviceID: string

Current device ID.

homeserver: string

Beeper homeserver URL for this account.

userID: string

Signed-in Beeper user ID.

verification?: Verification { id, availableActions, direction, 8 more }

Trusted device verification progress.

id: string

Verification ID to pass in verification action paths.

availableActions: Array<"accept" | "cancel" | "qr.confirmScanned" | 2 more>

Verification actions that are valid for the current state.

One of the following:

"accept"

"cancel"

"qr.confirmScanned"

"sas.start"

"sas.confirm"

direction: "incoming" | "outgoing"

Whether this device started or received the verification.

One of the following:

"incoming"

"outgoing"

methods: Array<"qr" | "sas">

Verification methods supported for this transaction.

One of the following:

"qr"

"sas"

purpose: "login" | "device"

Why this verification exists.

One of the following:

"login"

"device"

state: "requested" | "ready" | "sas_ready" | 4 more

Current trusted-device verification state.

One of the following:

"requested"

"ready"

"sas_ready"

"qr_scanned"

"done"

"cancelled"

"error"

error?: Error { code, reason }

Verification error details, if verification stopped.

code: string

Verification error code.

reason: string

User-facing verification error message.

otherDevice?: OtherDevice { id, name }

Other device participating in verification.

id: string

Other device ID.

name?: string

Other device display name, if known.

otherUserID?: string

Other Beeper user participating in verification.

qr?: Qr { data }

QR verification data.

data: string

QR code payload to display for verification.

sas?: SAS { emojis, decimals }

Emoji or number comparison data for verification.

emojis: string

Emoji sequence to compare on both devices.

decimals?: string

Number sequence to compare on both devices.

ResetConfirmResponse { session }

session: Session { e2ee, state, matrix, verification }

Current app sign-in and encrypted messaging setup state.

e2ee: E2EE { crossSigning, firstSyncDone, hasBackedUpRecoveryKey, 6 more }

Encrypted messaging setup status.

crossSigning: boolean

Whether this account can verify trusted devices.

firstSyncDone: boolean

Whether the first encrypted message sync is complete.

hasBackedUpRecoveryKey: boolean

Whether the user confirmed that they saved their recovery key.

initialized: boolean

Whether encrypted messaging setup has started.

keyBackup: boolean

Whether encrypted message backup is available.

secrets: Secrets { masterKey, megolmBackupKey, recoveryKey, 2 more }

Encrypted messaging keys available on this device.

masterKey: boolean

Whether the account identity key is available.

megolmBackupKey: boolean

Whether the encrypted message backup key is available.

recoveryKey: boolean

Whether a recovery key is available.

selfSigningKey: boolean

Whether the device trust key is available.

userSigningKey: boolean

Whether the user trust key is available.

secretStorage: boolean

Whether secure key storage is available.

verified: boolean

Whether this device is trusted for encrypted messages.

recoveryKeyGeneratedAt?: number

Unix timestamp for when the recovery key was created.

state: "needs-login" | "initializing" | "needs-cross-signing-setup" | 4 more

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

"needs-login"

"initializing"

"needs-cross-signing-setup"

"needs-verification"

"needs-secrets"

"needs-first-sync"

"ready"

matrix?: Matrix { deviceID, homeserver, userID }

Signed-in account details. Omitted until sign-in is complete.

deviceID: string

Current device ID.

homeserver: string

Beeper homeserver URL for this account.

userID: string

Signed-in Beeper user ID.

verification?: Verification { id, availableActions, direction, 8 more }

Trusted device verification progress.

id: string

Verification ID to pass in verification action paths.

availableActions: Array<"accept" | "cancel" | "qr.confirmScanned" | 2 more>

Verification actions that are valid for the current state.

One of the following:

"accept"

"cancel"

"qr.confirmScanned"

"sas.start"

"sas.confirm"

direction: "incoming" | "outgoing"

Whether this device started or received the verification.

One of the following:

"incoming"

"outgoing"

methods: Array<"qr" | "sas">

Verification methods supported for this transaction.

One of the following:

"qr"

"sas"

purpose: "login" | "device"

Why this verification exists.

One of the following:

"login"

"device"

state: "requested" | "ready" | "sas_ready" | 4 more

Current trusted-device verification state.

One of the following:

"requested"

"ready"

"sas_ready"

"qr_scanned"

"done"

"cancelled"

"error"

error?: Error { code, reason }

Verification error details, if verification stopped.

code: string

Verification error code.

reason: string

User-facing verification error message.

otherDevice?: OtherDevice { id, name }

Other device participating in verification.

id: string

Other device ID.

name?: string

Other device display name, if known.

otherUserID?: string

Other Beeper user participating in verification.

qr?: Qr { data }

QR verification data.

data: string

QR code payload to display for verification.

sas?: SAS { emojis, decimals }

Emoji or number comparison data for verification.

emojis: string

Emoji sequence to compare on both devices.

decimals?: string

Number sequence to compare on both devices.