Shared

ModelsExpand Collapse

APIError

string code

string message

?array<string,mixed> details

AppStateSnapshot

E2EE e2ee

Encrypted messaging setup status.

State state

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

?Matrix matrix

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

?Verification verification

Trusted device verification progress.

Attachment

Type type

Attachment type.

?string id

Attachment identifier, typically an mxc:// URL. Use the download file endpoint to get a local file path.

?float duration

Duration in seconds (audio/video).

?string fileName

Original filename if available.

?float fileSize

File size in bytes if known.

?bool isGif

True if the attachment is a GIF.

?bool isSticker

True if the attachment is a sticker.

?bool isVoiceNote

True if the attachment is a voice note.

?string mimeType

MIME type if known (e.g., ‘image/png’).

?string posterImg

Preview image URL for video attachments (poster frame). May be temporary or available only on this device; download promptly if durable access is needed.

?Size size

Pixel dimensions of the attachment: width/height in px.

?string srcURL

Public URL or local file path to fetch the file. May be temporary or available only on this device; download promptly if durable access is needed.

?Transcription transcription

Attachment transcription if available.

AttachmentCapabilities

array<string,MimeType> mimeTypes

Supported MIME types or MIME patterns for this file message type. Missing MIME types should be treated as rejected.

?Caption caption

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

?int maxCaptionLength

Maximum caption length when captions are supported.

?int maxDuration

Maximum audio or video duration in seconds.

?int maxHeight

Maximum image or video height in pixels.

?int maxSize

Maximum file size in bytes.

?int maxWidth

Maximum image or video width in pixels.

?bool viewOnce

True if this file type can be sent as view-once media.

ChatCapabilities

?list<string> allowedReactions

Allowed Unicode reactions. Omitted means all emoji reactions are allowed.

?bool archive

True if archive/unarchive is supported.

?array<string,AttachmentCapabilities> attachments

Supported attachment message types and their per-type constraints, keyed by Matrix msgtype or pseudo-msgtype (for example m.image, m.video, org.matrix.msc3245.voice). Missing message types should be treated as rejected.

?bool customEmojiReactions

True if custom emoji reactions are supported.

?Delete delete

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

?bool deleteChat

True if deleting chats for the authenticated user is supported.

?bool deleteChatForEveryone

True if deleting chats for everyone is supported.

?bool deleteForMe

True if deleting messages only for the authenticated user is supported.

?int deleteMaxAge

Maximum message age for delete-for-everyone, in seconds.

?DisappearingTimer disappearingTimer

Disappearing-message timer capabilities.

?Edit edit

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

?int editMaxAge

Maximum message age for edits, in seconds.

?int editMaxCount

Maximum number of edits allowed for one message.

?array<string,Formatting> formatting

Supported rich-text formatting features keyed by feature name (for example bold, inline_code, code_block.syntax_highlighting). Omitted means no formatting support is advertised.

?LocationMessage locationMessage

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

?bool markAsUnread

True if marking chats unread is supported.

?int maxTextLength

Maximum length of normal text messages.

?MessageRequest messageRequest

Message request capabilities.

?ParticipantActions participantActions

Participant management capabilities.

?Poll poll

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

?Reaction reaction

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

?int reactionCount

Maximum number of reactions allowed on a single message.

?bool readReceipts

True if read receipts are supported.

?Reply reply

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

?ChatStateCapabilities state

Chat state update capabilities.

?Thread thread

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

?bool typingNotifications

True if typing notifications are supported.

ChatDraft

string text

Rich-text draft body as returned by Beeper.

?array<string,DraftAttachment> attachments

Draft attachments keyed by attachment ID.

ChatStateCapabilities

?Avatar avatar

Chat avatar state capability.

?Description description

Chat description/topic state capability.

?DisappearingTimer disappearingTimer

Disappearing-message timer state capability.

?Title title

Chat title state capability.

DraftAttachment

string id

Draft attachment identifier.

Type type

Draft attachment type. GIF and recorded audio are mutually exclusive types.

?float audioDurationSeconds

Audio duration in seconds if known.

?string fileName

Original filename if available.

?string filePath

Local filesystem path for the draft attachment.

?float fileSize

File size in bytes if known.

?string mimeType

MIME type if known.

?Size size

Pixel dimensions of the attachment.

?string stickerID

Sticker identifier if the draft attachment is a sticker.

Error

string code

Machine-readable error code

string message

Error message

?Details details

Additional error details for debugging

LinkPreview

string title

Link preview title.

string url

Resolved link URL.

?string favicon

Favicon URL if available. May be temporary or available only on this device; download promptly if durable access is needed.

?string img

Preview image URL if available. May be temporary or available only on this device; download promptly if durable access is needed.

?ImgSize imgSize

Preview image dimensions.

?string originalURL

Original URL when the displayed URL is shortened or redirected.

?string summary

Link preview summary.

Message

string id

Message ID.

string accountID

Beeper account ID the message belongs to.

string chatID

Chat ID. Input routes also accept the local chat ID from this installation when available.

string senderID

Fully qualified sender user ID. Network-backed IDs usually include the network prefix and homeserver.

string sortKey

A unique, sortable key used to sort messages.

\Datetime timestamp

Message timestamp.

?list<Attachment> attachments

Attachments included with this message, if any.

?\Datetime editedTimestamp

Timestamp when the message was edited, if known.

?bool isDeleted

True if the message has been deleted.

?bool isHidden

True if the message is hidden from normal display.

?bool isSender

True if the authenticated user sent the message.

?bool isUnread

True if the message is unread for the authenticated user. May be omitted.

?string linkedMessageID

ID of the message this is a reply to, if any.

?list<LinkPreview> links

Link previews included with this message, if any.

?list<string> mentions

Mentioned user IDs, @room, or null for legacy messages that require text scanning.

?list<Reaction> reactions

Reactions to the message, if any.

?Seen seen

Read receipt state for this message, when available.

?string senderName

Resolved sender display name.

?SendStatus sendStatus

Message send status for this message, when reported by the bridge.

?string text

Rich-text message body if present.

?Type type

Message content type. Useful for distinguishing reactions, media messages, and state events from regular text messages.

Reaction

string id

Reaction ID. When a participant can react more than once, the ID is the participant ID concatenated with the reaction key; otherwise it equals the participant ID.

string participantID

User ID of the participant who reacted.

string reactionKey

The reaction key: an emoji (😄), a network-specific key, or a shortcode like “smiling-face”.

?bool emoji

True if the reactionKey is an emoji.

?string imgURL

URL to the reaction’s image. May be temporary or available only on this device; download promptly if durable access is needed.

SendStatus

Status status

Current status of the message send attempt.

\Datetime timestamp

Timestamp for the send status event.

?list<string> deliveredToUsers

User IDs the message was delivered to, when reported by the network.

?string internalError

Diagnostic error detail from the messaging network adapter. Do not show directly to users.

?string message

Human-readable send status or failure message.

?string reason

Machine-readable failure reason. Present when the send status is a failure.

User

string id

Stable Beeper user ID. Use as the primary key when referencing a person.

?bool cannotMessage

True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.

?string email

Email address if known. Not guaranteed verified.

?string fullName

Display name as shown in clients (e.g., ‘Alice Example’). May include emojis.

?string imgURL

Avatar image URL if available. This may be a remote URL, media URL, data URL, or local file URL depending on the source. May be temporary or available only on this device; download promptly if durable access is needed.

?bool isSelf

True if this user represents the authenticated account’s own identity.

?string phoneNumber

User’s phone number in E.164 format (e.g., ‘+14155552671’). Omit if unknown.

?string username

Human-readable handle if available (e.g., ‘@alice’). May be network-specific and not globally unique.