Shared
ModelsExpand Collapse
class Attachment: …
type: Literal["unknown", "img", "video", "audio"]Attachment type.
Attachment type.
Attachment identifier (typically an mxc:// URL). Use with /v1/assets/download to get a local file path.
Duration in seconds (audio/video).
Original filename if available.
File size in bytes if known.
True if the attachment is a GIF.
True if the attachment is a sticker.
True if the attachment is a voice note.
MIME type if known (e.g., 'image/png').
Preview image URL for video attachments (poster frame). May be temporary or local-only to this device; download promptly if durable access is needed.
size: Optional[Size]Pixel dimensions of the attachment: width/height in px.
Pixel dimensions of the attachment: width/height in px.
Public URL or local file path to fetch the asset. May be temporary or local-only to this device; download promptly if durable access is needed.
class Error: …
Machine-readable error code
Error message
details: Optional[Details]Additional error details for debugging
Additional error details for debugging
class DetailsValidationDetails: …Validation error details
Validation error details
issues: List[DetailsValidationDetailsIssue]List of validation issues
List of validation issues
Validation issue code
Human-readable description of the validation issue
path: List[Union[str, float]]Path pointing to the invalid field within the payload
Path pointing to the invalid field within the payload
Additional error context
Arbitrary details payload supplied by the server
class Message: …
Message ID.
Beeper account ID the message belongs to.
Unique identifier of the chat.
Sender user ID.
A unique, sortable key used to sort messages.
Message timestamp.
Attachments included with this message, if any.
Attachments included with this message, if any.
type: Literal["unknown", "img", "video", "audio"]Attachment type.
Attachment type.
Attachment identifier (typically an mxc:// URL). Use with /v1/assets/download to get a local file path.
Duration in seconds (audio/video).
Original filename if available.
File size in bytes if known.
True if the attachment is a GIF.
True if the attachment is a sticker.
True if the attachment is a voice note.
MIME type if known (e.g., 'image/png').
Preview image URL for video attachments (poster frame). May be temporary or local-only to this device; download promptly if durable access is needed.
size: Optional[Size]Pixel dimensions of the attachment: width/height in px.
Pixel dimensions of the attachment: width/height in px.
Public URL or local file path to fetch the asset. May be temporary or local-only to this device; download promptly if durable access is needed.
True if the authenticated user sent the message.
True if the message is unread for the authenticated user. May be omitted.
ID of the message this is a reply to, if any.
Reactions to the message, if any.
Reactions to the message, if any.
Reaction ID, typically ${participantID}${reactionKey} if multiple reactions allowed, or just participantID otherwise.
User ID of the participant who reacted.
The reaction key: an emoji (😄), a network-specific key, or a shortcode like "smiling-face".
True if the reactionKey is an emoji.
URL to the reaction's image. May be temporary or local-only to this device; download promptly if durable access is needed.
Resolved sender display name (impersonator/full name/username/participant name).
Plain-text body if present. May include a JSON fallback with text entities for rich messages.
type: Optional[Literal["TEXT", "NOTICE", "IMAGE", 7 more]]Message content type. Useful for distinguishing reactions, media messages, and state events from regular text messages.
Message content type. Useful for distinguishing reactions, media messages, and state events from regular text messages.
class Reaction: …
Reaction ID, typically ${participantID}${reactionKey} if multiple reactions allowed, or just participantID otherwise.
User ID of the participant who reacted.
The reaction key: an emoji (😄), a network-specific key, or a shortcode like "smiling-face".
True if the reactionKey is an emoji.
URL to the reaction's image. May be temporary or local-only to this device; download promptly if durable access is needed.
class User: …User the account belongs to.
User the account belongs to.
Stable Beeper user ID. Use as the primary key when referencing a person.
True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.
Email address if known. Not guaranteed verified.
Display name as shown in clients (e.g., 'Alice Example'). May include emojis.
Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.
True if this user represents the authenticated account's own identity.
User's phone number in E.164 format (e.g., '+14155552671'). Omit if unknown.
Human-readable handle if available (e.g., '@alice'). May be network-specific and not globally unique.