API v…Open Console →Console

Getting Started

Introduction Quickstart Installation First Request

Concepts

Projects API Keys Authentication Rate Limits Webhooks Request Lifecycle Error Explorer

Guides

User Authentication Handling Webhooks Pagination Error Handling Realtime Events Chat (API & realtime)Files & storage Roles & feature permissions Background Jobs

SDKs

Overview JavaScript Python Ruby Go Java C#PHP Swift

Realtime

Socket.IO Server-Sent Events

Developer Tools

API Playground Live API Logs Socket.IO tester

API Reference

auth

Register New User Login User Refresh Access Token Logout User Get Current Session Request Password Reset Confirm Password Reset With Otp Reset Password With Token Initiate Oauth Authentication Oauth Callback Handler List Available Oauth Providers Send Magic Link Verify Magic Link Send Otp Code Verify Otp Code Create Anonymous Session Convert Anonymous Account To Full Account Verify Email Address Resend Verification Email

users

Get Current User Profile Update User Profile Change Password Initiate Two-Factor Authentication Setup Verify And Enable 2fa Disable 2fa Verify Email Address Resend Verification Email Export User Data Delete User Data List Linked Oauth Providers Link Oauth Provider To Account Unlink Oauth Provider

roleElevation

Request Role Elevation Get Role Elevation Status Upload Verification Documents

multiRole

Get Permissions Matrix Get Multi-Role Feature Configuration Update Multi-Role Feature Settings Simulate App-Role Feature Permission For A Path Apply Admin / User / Viewer Feature Permission Preset Toggle Role On/Off Update Role Configuration Add Custom Role Update Collection Permissions For A Role Get Available Roles For Signup Register User With Specific Role Oauth Signup With Specific Role

collections

List Collections In Project Create New Collection Get Single Collection Update Collection Delete Collection

data

List Data In Collection Create Data In Collection Get Single Document Update Document Delete Document

storage

List Buckets In A Project Create New Bucket Get Bucket Details Update Bucket Delete Bucket List Files In Bucket Upload Files To Bucket Get File Metadata Delete File Generate A Presigned Url For Downloading A File Generate Presigned Post Data For Direct Browser Upload Confirm Direct Upload Generate Signed Url For File Download File From Bucket

webhooks

Get Webhook Statistics

functions

Trigger Webhook Functions List Functions Create Function Get Function Update Function Delete Function Activate Function Deactivate Function Execute Function Get Function Execution Logs Retry Failed Execution Rollback To Previous Version Get Function Versions Simulate Trigger

messaging

Send Push Notification Send Transactional Email Send Sms To One Or More Recipients Get Message History Get Message Statistics

usage

Get Project Usage Get Usage Trends

search

Full-Text Search Get Search Suggestions Get Search Analytics

wallet

Register A Non-Custodial Wallet Address List Registered Non-Custodial Addresses Get Non-Custodial Address By Id Delete A Non-Custodial Address Get Balance For A Non-Custodial Address Get Transaction History For A Non-Custodial Address Get Transaction By Hash Broadcast A Client-Signed Transaction Get Replacement Tx Params For Speed-Up Get Replacement Tx Params For Cancel Estimate Network Fee From Blockchain List Wallet Webhooks Create Wallet Webhook Update Wallet Webhook Delete Wallet Webhook Get Webhook Delivery Logs Test A Webhook Delivery

billing

Get Public Plans Create Checkout Session Get Checkout Payment Details Verify Payment And Create Subscription Check Subscription Status Check Feature Access Record Usage Crypto Payment Processor Webhook Flutterwave Webhook Initialize Fiat Payment

chat

Get User Chats Create New Chat Get Chat Details Register Chat E2ee Identity Public Key List Participant E2ee Public Keys Get Chat Messages Send Message Mark Messages As Read Add Reaction To Message Remove Reaction From Message Edit Message Delete Message Add Participant To Chat Remove Participant From Chat

integrations

Get Project Integrations Execute Integration

health

Health Check System Status

compliance

Log Security Event

realtimeAnalytics

Get Project Real-Time Analytics Get Active Users For A Project Check Presence Status For Users Get Event Throughput Metrics Get Historical Analytics

Concepts

API Keys

API keys authenticate requests to the MUDBASE API. Create and manage keys in the Console.

Content for this page will cover creating keys, scopes, and best practices for securing keys.

PreviousProjects NextAuthentication (Concepts)