API Reference

Complete reference of all available operations across the SingleBase platform APIs.

Datastore API

Operation	Description
collection.find	Retrieve one or multiple documents from a collection with filtering, sorting, and pagination
collection.insert	Insert one or multiple new documents into a collection
collection.update	Update existing documents by key or match criteria
collection.upsert	Update existing documents or insert new ones if no matches are found
collection.count	Count documents in a collection that match specific criteria
collection.delete	Delete documents from a collection (recoverable with reference ID)
collection.archive	Archive documents to hide them from queries while keeping them in storage
collection.restore	Restore previously archived or deleted documents using reference ID

Auth API

Operation	Description
auth.signin	Sign in users with password, OTP, or invite-based authentication methods
auth.signup	Register new user accounts with email, password, and profile information
auth.signout	Sign out users and invalidate their current session
auth.update_profile	Update user profile information including display name, phone, photo, and metadata
auth.update_account	Update core account details (email, password, username) with OTP verification
auth.send_otp	Generate and send OTP codes via email for various authentication operations
auth.verify_id_token	Verify the validity of a JWT ID token for admin or server-side validation
auth.refresh_token	Refresh expired authentication tokens using a valid refresh token
auth.settings	Retrieve public authentication configuration and password policies
auth.nonce	Generate nonce values for OAuth authentication flows

XAP API

Operation	Description
xai.generate	Generate new content based on user prompts
xai.summarize	Create concise summaries of long-form content
xai.classify	Categorize content into predefined or custom classifications
xai.sentiment	Analyze emotional tone and sentiment of text
xai.extract	Extract specific entities and information from content
xai.translate	Translate content between languages
xai.vectorize	Convert text content into vector embeddings

Vectorstore Overview

Endpoint	Description
vdb.insert	Insert vectors and metadata into collections
vdb.search	Perform semantic similarity search across vectors
vdb.delete	Delete vector entries by keys

Filestore API

Operation	Description
file.info	Retrieve file information including URL, metadata, and access permissions
file.update	Update file permissions, visibility settings, and metadata
file.delete	Permanently delete files from storage
file.presign_upload	Generate secure presigned URLs and validate file uploads before they occur
file.postsign_upload	Complete the file upload process and finalize storage
file.upload_error	Report upload errors and handle failed upload attempts