Skip to content
Zentalk Developer
Search
Ctrl
K
Cancel
API
zentalk.chat
↗
GitHub
Select theme
Dark
Light
Auto
Getting started
Introduction
Quickstart
Authentication
Environments and base URLs
API reference
REST API
Overview
Authentication
Refresh CSRF token
POST
Revoke all sessions
POST
Migrate phone hash
POST
Revoke abandoned phone registration
POST
Get phone lockout status
GET
Phone login
POST
Phone login challenge
POST
Phone register
POST
Send SMS verification
POST
Verify SMS code
POST
Refresh access token
POST
Revoke refresh token
POST
Login with session cookie
POST
Session logout
POST
List active sessions
GET
Revoke session
DELETE
Logout
POST
Get current session
GET
List registered devices
GET
Revoke a device
DELETE
Register a device
POST
Initialize client session
POST
Resume existing session
POST
WebSocket
Get WebSocket ticket
POST
Channels
Get user's channels
GET
Create channel
POST
Discover channels
POST
Revoke channel invite
DELETE
Join channel via invite
POST
Get channel details
GET
Update channel
PUT
Delete channel
DELETE
Upload channel avatar
POST
Delete channel avatar
DELETE
Demote channel member
POST
List channel invites
GET
Create channel invite
POST
List channel members
GET
Search channel members
GET
Remove channel member
DELETE
List channel messages
GET
Post channel message
POST
Search channel messages
GET
Edit channel message
PUT
Delete channel message
DELETE
Pin channel message
POST
Unpin channel message
DELETE
Add channel reaction
POST
Remove channel reaction
DELETE
Record channel message view
POST
Mute channel notifications
POST
Promote channel member
POST
Mark channel as read
POST
Subscribe to channel
POST
Transfer channel ownership
POST
Unmute channel notifications
POST
Unsubscribe from channel
POST
Get channel avatar
GET
Federation
Generate authentication challenge
POST
Verify authentication challenge
POST
Get federation health
GET
Receive federated message
POST
Register federated server
POST
List federated servers
GET
Get federated server info
GET
Get federation status
GET
Lookup user's home server
POST
Groups
List my groups
GET
Create group
POST
Discover public groups
GET
Join group via invite
POST
Get group details
GET
Update a group
PUT
Delete group
DELETE
Upload group avatar
POST
Delete group avatar
DELETE
List group invites
GET
Create group invite
POST
Revoke group invite
DELETE
Join a group
POST
Leave a group
POST
Get group members
GET
Add group members
POST
Search group members
GET
Remove group member
DELETE
Demote group admin
POST
Promote group member
POST
List group messages
GET
Send group message
POST
Search group messages
GET
Edit group message
PUT
Delete group message
DELETE
Add group message reaction
POST
Remove group message reaction
DELETE
Mute group notifications
POST
Mark group as read
POST
Unmute group notifications
POST
Get group avatar
GET
Ban a user from a group
POST
Unban a user from a group
DELETE
List group bans
GET
Encryption
Publish E2EE key bundle
POST
Get E2EE key bundle
GET
Claim one-time pre-key
POST
Messages
Search messages
GET
Add message reaction
POST
Clear chat
POST
Delete chat
POST
Delete message
POST
Edit message
POST
Forward message
POST
Mark messages as read
POST
Mark messages as read (batch)
POST
Mark messages delivered
POST
Get messages by sequence
GET
Pin a message
POST
Unpin a message
POST
Get chat messages
GET
Remove message reaction
POST
Send direct message
POST
Star message
POST
List starred messages
GET
Send typing indicator
POST
Unstar message
POST
MFA
Regenerate backup codes
POST
Get backup codes status
GET
Create MFA challenge
POST
Disable MFA
POST
Get lockout status
GET
Get login attempts
GET
Get MFA status
GET
Get trusted devices
GET
Revoke all trusted devices
DELETE
Revoke trusted device
DELETE
Verify MFA challenge
POST
Cancel MFA recovery
POST
Request MFA recovery
POST
Get MFA recovery status
GET
Verify MFA recovery
POST
Enable TOTP
POST
Setup TOTP
POST
Polls
Create poll
POST
Get poll
GET
Get poll results
GET
Vote on poll
POST
Vote on a poll
POST
Close a poll
POST
push
Subscribe to push notifications
POST
Unsubscribe from push notifications
POST
Get VAPID public key
GET
Stickers
Get sticker packs
GET
Create sticker pack
POST
Get sticker pack
GET
Send sticker
POST
Get sticker image
GET
List my sticker packs
GET
Install sticker pack
POST
Uninstall sticker pack
DELETE
Stories
Get stories
GET
Post a story
POST
Get a story
GET
Delete a story
DELETE
View a story
POST
Get story views
GET
Abuse Reports
Submit abuse report
POST
List abuse reports (admin)
GET
Account
Get consent log
GET
Record consent
POST
Revoke consent
DELETE
Export account data
GET
Push Notifications
Register native push-notification token
POST
Revoke native push-notification token
DELETE
Admin RBAC
List RBAC permissions
GET
List RBAC roles
GET
Ban user (RBAC)
POST
Unban user (RBAC)
DELETE
Check user ban status
GET
List user roles
GET
Assign user role
POST
Revoke user role
DELETE
Admin Security
Get security dashboard
GET
Get security events
GET
Get IP blacklist
GET
Add IP to blacklist
POST
Remove IP from blacklist
DELETE
Get account lockouts
GET
Unlock account
DELETE
Get login statistics
GET
Autocomplete
Autocomplete channels
GET
Autocomplete groups
GET
Autocomplete users
GET
Avatar
Delete my avatar
DELETE
Get avatar chunk
GET
Upload avatar
POST
Get user avatar
GET
Security
Fetch backup pepper
POST
TLS certificate info
GET
Contacts
Block contact
POST
List users who blocked me
GET
List blocked contacts
GET
Confirm verification
POST
Discover contacts
POST
Invite friends
POST
Mute user notifications
POST
List muted users
GET
Send verification request
POST
Unblock contact
POST
Unmute user notifications
POST
Unverify contact safety number
POST
Verify contact safety number
POST
Calls
Get call history
GET
Log call event
POST
Mark call history as read
POST
Get unread call count
GET
Chats
Get disappearing-message timer
GET
Update disappearing-message timer
PUT
Get disappearing-timer change history
GET
Cancel chat export
POST
Download chat export
POST
Download chat export file
GET
List my export requests
GET
List pending export responses
GET
Request chat export
POST
Respond to chat-export request
POST
Check chat-export status
GET
List chats
GET
List pinned messages
GET
Users
Check username availability
POST
Delete account
POST
Get my profile
GET
Update profile
POST
Update status
POST
Update username
POST
Get user public profile
GET
Media
Send file
POST
Get file messages
GET
Get avatar media chunk
GET
Get media blob
GET
Issue signed media URL
POST
Upload media
POST
Send video message
POST
Get video messages
GET
Send voice message
POST
Get voice messages
GET
Key Transparency
Lookup KTL identity
GET
Get latest KTL signed tree root
GET
Verify a KTL entry by sequence number
GET
Links
Fetch link preview (cached)
GET
Fetch link preview
POST
Location
List location-sharing sessions
GET
Start live location sharing
POST
Stop live location sharing
POST
Update shared location
POST
Messaging
Schedule a message
POST
List scheduled messages
GET
Cancel a scheduled message
DELETE
Mark a view-once message as viewed
POST
Network
Get network status
GET
Peers
Get peer info
POST
Presence
Publish encrypted presence
POST
Get encrypted presence
GET
Get presence key
GET
Request presence access
POST
RBAC
Check my permission
GET
List my roles
GET
Recovery
Recovery audit log
GET
Regenerate backup codes
POST
Cancel recovery request
POST
Get recovery challenge
POST
Get recovery config
GET
Update recovery config
PUT
Execute account recovery
POST
Freeze account
POST
List guardian approvals
GET
Approve recovery request
POST
Confirm guardian role
POST
List pending guardianships
GET
Reject recovery request
POST
List recovery guardians
GET
Add recovery guardian
POST
Remove recovery guardian
DELETE
Initiate account recovery
POST
Setup account recovery
POST
Get recovery request status
GET
Unfreeze account
POST
Sealed Sender
Relay sealed-sender envelope (legacy)
POST
Relay sealed-sender v3 envelope
POST
Issue sealed-sender certificate
POST
Get sealed-sender bucket secret
GET
WebRTC
Get ICE servers configuration
GET
System
Debug information (restricted)
GET
Get error logs
GET
Log frontend errors
POST
Mesh Storage API
Overview
storage
Overview
Upload data to distributed storage
POST
Download data from distributed storage
GET
Check data chunk status
GET
Delete data chunk
DELETE
network
Overview
Get network information
GET
Get connected peers
GET
Get network health status
GET
node
Overview
Get node information
GET
Get node statistics
GET
health
Overview
Basic health check
GET
Prometheus metrics
GET
API conventions
API versioning and lifecycle
Rate limits
Error handling
Glossary
Realtime
WebSocket connection
Event catalog
Calls and WebRTC
SDKs & libraries
SDK overview
TypeScript client
Go client
SDK roadmap
Planned
Security & encryption
Security overview
X3DH key agreement
Double Ratchet
Post-quantum hybrid encryption
Group and channel encryption
Sealed sender
Key Transparency Log
Contact verification
Federation
Beta
Federation overview
Federation setup
Operators
Run a validator
Node binaries and ports
CLI reference
GitHub
Select theme
Dark
Light
Auto
Overview
storage
Section titled “storage”
Distributed storage operations
Operations
Section titled “Operations”
POST
/api/v1/storage/upload
GET
/api/v1/storage/download/{userAddr}/{chunkID}
GET
/api/v1/storage/status/{userAddr}/{chunkID}
DELETE
/api/v1/storage/delete/{userAddr}/{chunkID}
