Skip to content
Build with XMTP
Search
Ctrl
K
Cancel
GitHub
Get started
SDK guide
Content types
Agents
Protocol
Specs
Reference
Menu
Get started
Build a quickstart chat app
Install the XMTP SDK
Run the backend
Migrate to a self-hosted backend
Migration overview
Browser SDK Upgrade Guide
Node SDK Upgrade Guide
Kotlin SDK Upgrade Guide
Swift SDK Upgrade Guide
Agent SDK Upgrade Guide
Deploy
Deployment overview
Run a local XMTP node with Tailscale
Deploy on Fly.io
Deploy on Railway
AWS ECS (Fargate)
Deploy on Kubernetes
Push configuration
SDK guide
Client
Signer
Inboxes
Conversations and group chats
Send messages
Read conversations and messages
Stream messages
Events
Sync
Backups
Groups
Consent
Disappearing messages
Delete messages
Push notifications
Debug
Use signatures
Extend the identity model
Content types
Understand content types with XMTP
Support attachments in your app built with XMTP
Reactions
Replies
Read receipts
Actions and intents
Wallet transactions
Transaction references
Stream group updates with XMTP
Markdown
Agents
Build an agent
Agent events
Agent middleware
Agent filters
Agent context
Deploy an agent
Tools
XMTP CLI
XMTP web chat
Protocol
MLS protocol overview
Messaging security
Envelope types
Topics
Epochs with XMTP
Intents with XMTP
Cursors
Identity model
Specs
Specifications
Specification format
Glossary
Prefix registry
Backend API contract
Archive format
Remote attachments
Backend auth
Backend configuration
Consent
Content types
DMs and stitching
Client events
Fork recovery and the commit log
Modifying groups
Identity updates
Joining groups
Client logging
Group metadata and app data
Legacy database migration
Backend operations
Group permissions
Message processing
Push subscriptions and webhooks
Message sending
Client storage
Device sync
Topic format
Reference
Rate limits and capacity
XMTP error code glossary
Node SDK
Classes
ActionsCodec
Archives
AttachmentCodec
Attachments
Backend
Client
ConversationReader
Conversations
ConversationStream
DeleteMessageCodec
Diagnostics
Dm
EventReader
EventStream
Group
GroupUpdatedCodec
IntentCodec
LeaveRequestCodec
LocalSigningKey
MarkdownCodec
Message
MessageReader
MessageStream
MultiRemoteAttachmentCodec
PendingAttachment
Preferences
ReactionV2Codec
ReadReceiptCodec
RemoteAttachmentCodec
ReplyCodec
SignatureRequest
Storage
TextCodec
Timestamp
TransactionReferenceCodec
WalletSendCallsCodec
XmtpError
Interfaces
ContentCodec
CredentialSource
EventListener
LogSink
PreAuthenticate
Signer
Type Aliases
Action
Actions
ActionStyle
AnyContentCodec
ApiStats
ApplicationComponentDefinition
ArchiveElement
ArchiveMetadata
ArchiveOptions
ArchiveRestored
Attachment
AttachmentFailed
AttachmentFailure
AttachmentFailureCause
AttachmentOptions
AttachmentRef
AttachmentsConfiguration
AttachmentSource
AuthConfiguration
BackendOptions
BackendSource
CatchUpSummary
ClientEvent
ClientHandlers
ClientOptions
ClientRejectedByServer
CommitLogForkStatus
ComponentMutation
ComponentPermissions
Compression
ConnectionState
ConnectionStateChanged
ConsentChanged
ConsentEntity
ConsentEntityKind
ConsentRecord
ConsentState
ContentTypeId
Conversation
ConversationDebugInfo
ConversationId
ConversationJoined
ConversationKind
ConversationMessageReaderOptions
ConversationMessageStreamOptions
ConversationOrder
ConversationPaused
ConversationReaderOptions
ConversationRemoved
ConversationState
ConversationStreamOptions
CreateDmOptions
CreateGroupOptions
Credential
CredentialFailureKind
DeletedBy
DeletedMessage
DeleteMessageContent
DeletionCause
DeliveryCursor
DeliveryStatus
DisappearingSettings
DownloadedAttachment
EncodedContent
EncryptedEncodedContent
EncryptionKeys
ErrorCategory
ErrorDetails
EventConsentState
EventContentTypeId
EventConversationType
EventFilter
EventKind
EventMessageStatus
FieldKey
FieldValue
ForkRecoveryOptions
ForkRecoveryPolicy
GroupMembershipCapabilities
GroupPermissionMode
GroupPermissions
GroupPolicyType
GroupRef
GroupState
GroupSyncSummary
GroupUpdated
HandleChanged
HandlesConfiguration
HmacKey
HmacKeysUpdated
IdentityRegistered
IdentityStats
InboxCapabilities
InboxId
InboxState
Installation
InstallationCapabilities
InstallationId
InstallationRef
InstallationRevoked
Intent
JoinOrigin
KeyPackageLifetime
KeyPackageStatus
Lagged
LeaveRequest
LimitsConfiguration
ListConversationsOptions
ListenerId
ListMessagesOptions
LocalAttachment
LockoutChange
LockoutChanged
LoggingOptions
LogLevel
LogProcessType
LogRecord
LogRotation
MapEntry
MapMutation
Member
MembershipChanged
MembershipResult
MembershipState
MessageBody
MessageContent
MessageDeleted
MessageHistoryPage
MessageHistoryPosition
MessageHistorySnapshot
MessageId
MessageKind
MessageMetadataEntry
MessageOrder
MessageReaderOptions
MessageReceived
MessageRecoveryPage
MessageRecoveryPosition
MessageRef
MessageSortBy
MessageStatusChanged
MessageStreamOptions
MetadataBasePolicy
MetadataChanged
MetadataComponentType
MetadataFieldChange
MetadataFieldDescriptor
MetadataFieldKind
MetadataFieldRef
MetadataFieldValue
MetadataKeyType
MetadataPolicy
MetadataScalarType
MetadataValue
MigrationReport
MlsConfiguration
MlsExtensionType
MultiRemoteAttachment
NotificationChannel
NotificationConfig
NotificationFailure
NotificationOverride
NotificationsFailed
NotificationState
OtelOptions
PendingAttachmentStatus
PermissionLevel
PermissionPolicy
PermissionPolicySet
PermissionUpdateKind
PrepareMigrationArchiveArgs
PublicIdentity
PublicIdentityKind
Reaction
ReactionAction
ReactionMessage
ReactionSchema
ReactionV2Content
RegistrationOptions
RejectionCause
RemoteAttachment
RemovalCause
ReplyContent
ReplyParent
RetentionConfiguration
SendOptions
ServerConfiguration
SetMutation
Signature
SignatureKind
SignerKind
SigningKeyDescription
SigningRequest
StandardContent
StandardContentKind
StorageLocation
StorageOptions
StoragePoolOptions
StreamBarrierCause
StreamBarrierCauseKind
StreamBarrierFailure
StreamBarrierReason
StreamBarrierTopic
StreamCloseReason
StreamFailureDetails
StreamFailureKind
StreamFailureSummary
StreamOptions
TransactionMetadata
TransactionReference
UserFieldUpdate
UserFieldValue
WalletCall
WalletCallMetadata
WalletSendCalls
WellKnownMetadataField
WorkerInterval
WorkerKind
WorkerOptions
Functions
canMessageWithBackend
catalogueContentTypeShouldPush
decodeEncodedContent
decodeStandard
decryptBytes
decryptEncodedContent
decryptFile
encodeEncodedContent
encodeStandard
encodeText
encryptBytes
encryptEncodedContent
encryptFile
enterDebugWriter
exitDebugWriter
fetchServerConfiguration
flushTelemetry
generateInboxId
generateKeys
generateLocalSigner
inboxIdForWithBackend
inboxStatesWithBackend
initLogging
isAddressAuthorizedWithBackend
isCatalogueContentType
isInstallationAuthorizedWithBackend
keyPackageStatusesWithBackend
latestInboxUpdatesCount
localSignerFromPrivateKey
metadataFieldRef
newestMessageMetadataWithBackend
prepareMigrationArchive
remoteAttachmentFromEncrypted
resumeStreams
revokeInstallationsWithBackend
sdkVersion
setLogSink
standardContentType
suspendStreams
verifySignedWithPublicKey
Browser SDK
Classes
Archives
Attachments
Backend
Client
ConversationReader
Conversations
ConversationStream
Diagnostics
Dm
EventReader
EventStream
Group
LocalSigningKey
Message
MessageReader
MessageStream
PendingAttachment
Preferences
SignatureRequest
Storage
Timestamp
XmtpError
Interfaces
ContentCodec
CredentialSource
EventListener
LogSink
PreAuthenticate
Signer
StorageAdmin
Type Aliases
Action
Actions
ActionStyle
AnyContentCodec
ApiStats
ApplicationComponentDefinition
ArchiveElement
ArchiveMetadata
ArchiveOptions
ArchiveRestored
Attachment
AttachmentFailed
AttachmentFailure
AttachmentFailureCause
AttachmentOptions
AttachmentRef
AttachmentsConfiguration
AttachmentSource
AuthConfiguration
BackendOptions
BackendSource
CatchUpSummary
ClientEvent
ClientHandlers
ClientOptions
ClientRejectedByServer
CommitLogForkStatus
ComponentMutation
ComponentPermissions
Compression
ConnectionState
ConnectionStateChanged
ConsentChanged
ConsentEntity
ConsentEntityKind
ConsentRecord
ConsentState
ContentTypeId
Conversation
ConversationDebugInfo
ConversationId
ConversationJoined
ConversationKind
ConversationMessageReaderOptions
ConversationMessageStreamOptions
ConversationOrder
ConversationPaused
ConversationReaderOptions
ConversationRemoved
ConversationState
ConversationStreamOptions
CreateDmOptions
CreateGroupOptions
Credential
CredentialFailureKind
DeletedBy
DeletedMessage
DeleteMessageContent
DeletionCause
DeliveryCursor
DeliveryStatus
DisappearingSettings
DownloadedAttachment
EncodedContent
EncryptedEncodedContent
EncryptionKeys
ErrorCategory
ErrorDetails
EventConsentState
EventContentTypeId
EventConversationType
EventFilter
EventKind
EventMessageStatus
FieldKey
FieldValue
ForkRecoveryOptions
ForkRecoveryPolicy
GroupMembershipCapabilities
GroupPermissionMode
GroupPermissions
GroupPolicyType
GroupRef
GroupState
GroupSyncSummary
GroupUpdated
HandleChanged
HandlesConfiguration
HmacKey
HmacKeysUpdated
IdentityRegistered
IdentityStats
InboxCapabilities
InboxId
InboxState
Installation
InstallationCapabilities
InstallationId
InstallationRef
InstallationRevoked
Intent
JoinOrigin
KeyPackageLifetime
KeyPackageStatus
Lagged
LeaveRequest
LimitsConfiguration
ListConversationsOptions
ListenerId
ListMessagesOptions
LocalAttachment
LockoutChange
LockoutChanged
LoggingOptions
LogLevel
LogRecord
MapEntry
MapMutation
Member
MembershipChanged
MembershipResult
MembershipState
MessageBody
MessageContent
MessageDeleted
MessageHistoryPage
MessageHistoryPosition
MessageHistorySnapshot
MessageId
MessageKind
MessageMetadataEntry
MessageOrder
MessageReaderOptions
MessageReceived
MessageRecoveryPage
MessageRecoveryPosition
MessageRef
MessageSortBy
MessageStatusChanged
MessageStreamOptions
MetadataBasePolicy
MetadataChanged
MetadataComponentType
MetadataFieldChange
MetadataFieldDescriptor
MetadataFieldKind
MetadataFieldRef
MetadataFieldValue
MetadataKeyType
MetadataPolicy
MetadataScalarType
MetadataValue
MigrationReport
MlsConfiguration
MlsExtensionType
MultiRemoteAttachment
NotificationOverride
NotificationsFailed
OtelOptions
PendingAttachmentStatus
PermissionLevel
PermissionPolicy
PermissionPolicySet
PermissionUpdateKind
PrepareMigrationArchiveArgs
PublicIdentity
PublicIdentityKind
Reaction
ReactionAction
ReactionMessage
ReactionSchema
ReactionV2Content
RegistrationOptions
RejectionCause
RemoteAttachment
RemovalCause
ReplyContent
ReplyParent
RetentionConfiguration
SendOptions
ServerConfiguration
SetMutation
Signature
SignatureKind
SignerKind
SigningKeyDescription
SigningRequest
StandardContent
StandardContentKind
StorageLocation
StorageOptions
StoragePoolOptions
StreamBarrierCause
StreamBarrierCauseKind
StreamBarrierFailure
StreamBarrierReason
StreamBarrierTopic
StreamCloseReason
StreamFailureDetails
StreamFailureKind
StreamFailureSummary
StreamOptions
TransactionMetadata
TransactionReference
UserFieldUpdate
UserFieldValue
WalletCall
WalletCallMetadata
WalletSendCalls
WellKnownMetadataField
WorkerInterval
WorkerKind
WorkerOptions
Functions
canMessageWithBackend
decryptBytes
decryptEncodedContent
encryptBytes
encryptEncodedContent
fetchServerConfiguration
flushTelemetry
generateInboxId
generateKeys
generateLocalSigner
inboxIdForWithBackend
inboxStatesWithBackend
initLogging
isAddressAuthorizedWithBackend
isInstallationAuthorizedWithBackend
keyPackageStatusesWithBackend
latestInboxUpdatesCount
localSignerFromPrivateKey
newestMessageMetadataWithBackend
prepareMigrationArchive
readMigrationArchive
revokeInstallationsWithBackend
setLogSink
verifySignedWithPublicKey
Agent SDK
Classes
ActionsCodec
ActionWizard
Agent
AgentError
AgentStreamingError
Archives
AttachmentCodec
Attachments
Backend
Client
ClientContext
CommandRouter
ConversationContext
ConversationReader
Conversations
ConversationStream
DeleteMessageCodec
Diagnostics
Dm
EventReader
EventStream
Group
GroupUpdatedCodec
IntentCodec
LeaveRequestCodec
LocalSigningKey
MarkdownCodec
Message
MessageContext
MessageReader
MessageStream
MultiRemoteAttachmentCodec
PendingAttachment
PerformanceMonitor
Preferences
ReactionV2Codec
ReadReceiptCodec
RemoteAttachmentCodec
ReplyCodec
SignatureRequest
Storage
TextCodec
Timestamp
TransactionReferenceCodec
WalletSendCallsCodec
XmtpError
Interfaces
CommandRouterConfig
ContentCodec
CredentialSource
EventListener
HealthReport
LogSink
PerformanceMonitorConfig
PreAuthenticate
Signer
Type Aliases
Action
Actions
ActionStyle
ActionWizardCancelHandler
ActionWizardCancelOptions
ActionWizardCompleteHandler
ActionWizardOptions
AgentBaseContext
AgentCreateOptions
AgentErrorContext
AgentErrorMiddleware
AgentErrorRegistrar
AgentMessageHandler
AgentMiddleware
AgentOptions
AgentStreamingOptions
AnyContentCodec
ApiStats
ApplicationComponentDefinition
ArchiveElement
ArchiveMetadata
ArchiveOptions
ArchiveRestored
Attachment
AttachmentFailed
AttachmentFailure
AttachmentFailureCause
AttachmentOptions
AttachmentRef
AttachmentsConfiguration
AttachmentSource
AttachmentUploadCallback
AuthConfiguration
BackendOptions
BackendSource
CatchUpSummary
ClientEvent
ClientHandlers
ClientOptions
ClientRejectedByServer
CommitLogForkStatus
ComponentMutation
ComponentPermissions
Compression
ConnectionState
ConnectionStateChanged
ConsentChanged
ConsentEntity
ConsentEntityKind
ConsentRecord
ConsentState
ContentTypeId
Conversation
ConversationDebugInfo
ConversationId
ConversationJoined
ConversationKind
ConversationMessageReaderOptions
ConversationMessageStreamOptions
ConversationOrder
ConversationPaused
ConversationReaderOptions
ConversationRemoved
ConversationState
ConversationStreamOptions
CreateDmOptions
CreateERC20TransferCallsOptions
CreateGroupOptions
CreateNativeTransferCallsOptions
Credential
CredentialFailureKind
DecodedMessageWithContent
DeletedBy
DeletedMessage
DeleteMessageContent
DeletionCause
DeliveryCursor
DeliveryStatus
DisappearingSettings
DownloadedAttachment
EncodedContent
EncryptedEncodedContent
EncryptionKeys
ErrorCategory
ErrorDetails
EventConsentState
EventContentTypeId
EventConversationType
EventFilter
EventHandlerMap
EventKind
EventMessageStatus
FieldKey
FieldValue
ForkRecoveryOptions
ForkRecoveryPolicy
GetERC20BalanceOptions
GetERC20DecimalsOptions
GroupMembershipCapabilities
GroupPermissionMode
GroupPermissions
GroupPolicyType
GroupRef
GroupState
GroupSyncSummary
GroupUpdated
HandleChanged
HandlesConfiguration
HmacKey
HmacKeysUpdated
HostedAttachment
IdentityRegistered
IdentityStats
InboxCapabilities
InboxId
InboxState
Installation
InstallationCapabilities
InstallationId
InstallationInfo
InstallationRef
InstallationRevoked
Intent
JoinOrigin
KeyPackageLifetime
KeyPackageStatus
Lagged
LeaveRequest
LimitsConfiguration
ListConversationsOptions
ListenerId
ListMessagesOptions
LocalAttachment
LockoutChange
LockoutChanged
LoggingOptions
LogLevel
LogProcessType
LogRecord
LogRotation
MapEntry
MapMutation
Member
MembershipChanged
MembershipResult
MembershipState
MessageBody
MessageContent
MessageContextParams
MessageDeleted
MessageHistoryPage
MessageHistoryPosition
MessageHistorySnapshot
MessageId
MessageKind
MessageMetadataEntry
MessageOrder
MessageReaderOptions
MessageReceived
MessageRecoveryPage
MessageRecoveryPosition
MessageRef
MessageSortBy
MessageStatusChanged
MessageStreamOptions
MetadataBasePolicy
MetadataChanged
MetadataComponentType
MetadataFieldChange
MetadataFieldDescriptor
MetadataFieldKind
MetadataFieldRef
MetadataFieldValue
MetadataKeyType
MetadataPolicy
MetadataScalarType
MetadataValue
MigrationReport
MlsConfiguration
MlsExtensionType
MultiRemoteAttachment
NotificationChannel
NotificationConfig
NotificationFailure
NotificationOverride
NotificationsFailed
NotificationState
OtelOptions
PendingAttachmentStatus
PermissionLevel
PermissionPolicy
PermissionPolicySet
PermissionUpdateKind
PrepareMigrationArchiveArgs
PublicIdentity
PublicIdentityKind
Reaction
ReactionAction
ReactionMessage
ReactionSchema
ReactionV2Content
RegistrationOptions
RejectionCause
RemoteAttachment
RemovalCause
ReplyContent
ReplyParent
RetentionConfiguration
SendOptions
ServerConfiguration
SetMutation
Signature
SignatureKind
SignerKind
SigningKeyDescription
SigningRequest
StandardContent
StandardContentKind
StorageLocation
StorageOptions
StoragePoolOptions
StreamAllMessagesOptions
StreamBarrierCause
StreamBarrierCauseKind
StreamBarrierFailure
StreamBarrierReason
StreamBarrierTopic
StreamCloseReason
StreamFailureDetails
StreamFailureKind
StreamFailureSummary
StreamOptions
TransactionMetadata
TransactionReference
User
UserFieldUpdate
UserFieldValue
WalletCall
WalletCallMetadata
WalletSendCalls
WellKnownMetadataField
WorkerInterval
WorkerKind
WorkerOptions
Variables
erc20Abi
f
filter
Functions
canMessageWithBackend
catalogueContentTypeShouldPush
createERC20TransferCalls
createIdentifier
createNameResolver
createNativeTransferCalls
createRemoteAttachment
createRemoteAttachmentFromFile
createSigner
createUser
decodeEncodedContent
decodeStandard
decryptBytes
decryptEncodedContent
decryptFile
downloadRemoteAttachment
encodeEncodedContent
encodeStandard
encodeText
encryptBytes
encryptEncodedContent
encryptFile
enterDebugWriter
exitDebugWriter
fetchServerConfiguration
flushTelemetry
generateInboxId
generateKeys
generateLocalSigner
getERC20Balance
getERC20Decimals
getInstallationInfo
getTestUrl
getValidLogLevels
inboxIdForWithBackend
inboxStatesWithBackend
initLogging
isAddressAuthorizedWithBackend
isCatalogueContentType
isInstallationAuthorizedWithBackend
keyPackageStatusesWithBackend
latestInboxUpdatesCount
localSignerFromPrivateKey
logDetails
metadataFieldRef
newestMessageMetadataWithBackend
parseLogLevel
prepareMigrationArchive
remoteAttachmentFromEncrypted
resumeStreams
revokeInstallationsWithBackend
sdkVersion
setLogSink
standardContentType
suspendStreams
verifySignedWithPublicKey
Swift SDK
Kotlin SDK
Rust
GitHub
sdkVersion
sdkVersion
():
string
Defined in: sdks/node/dist/public-values.gen.d.ts:18
Returns
Section titled “Returns”
string