Skip to content
Fluxbase
Search
Ctrl
K
Cancel
GitHub
Discord
Select theme
Dark
Light
Auto
Getting Started
Introduction
Quick Start
Developer Guide
Configuration
Configuration Reference
Resources
API Cookbook
Supabase Comparison
Guides
Authentication
Storage
Realtime
Edge Functions
Background Jobs
RPC
Multi-Tenancy
Row-Level Security
Database Migrations
Database Branching
Database Branching
Branching API Reference
GitHub Integration
Branching Workflows
Client Keys
Service Keys
Dashboard Auth
OAuth Providers
SAML SSO
Captcha
Vector Search
AI Chatbots
Knowledge Bases
MCP Server
Overview
Custom MCP Tools
Integration Guide
OAuth Authentication
Resources Reference
Tools Reference
Webhooks
User Settings
Secrets Management
Rate Limiting
Logging
Monitoring
Email Services
PostgreSQL Extensions
Image Transformations
Testing
Backup & Restore
Automation
Distributed Tracing
Operational Runbook
App Settings
Admin Dashboard
Admin Dashboard
Configuration Management
Initial Setup Guide
Tenant Management
User Impersonation
Tutorials
Build Your First API
Security
Security Best Practices
Branching Security
CSRF Protection
Endpoint Protection
MCP Security
Security Overview
Security Headers
SSRF Protection
TypeScript SDK
Admin SDK
Advanced Features
DDL SDK
Getting Started
User Impersonation SDK
Management SDK
OAuth Provider Configuration SDK
Settings SDK
React SDK
Getting Started
Svelte SDK
Getting Started
Next.js SDK
Getting Started
Vue SDK
Getting Started
CLI
Installation
Getting Started
Configuration
Command Reference
Overview
Auth
Functions
Jobs
Storage
Chatbots
Knowledge Bases (kb)
AI Providers
Tables
Types
GraphQL
RPC
Webhooks
Client Keys
Migrations
Schema
Internal Schema
Extensions
Realtime
Settings
Settings Secrets
Service Keys
Config
Secrets (Legacy)
Logs
MCP Tools
Sync
Branch
Admin
Users
Version
Completion
Command Aliases
Workflows
Deployment
Docker Deployment
Kubernetes Deployment
Deployment Overview
Production Deployment Checklist
Scaling Guide
API Reference
TypeScript SDK
classes
AppSettingsManager
AuthSettingsManager
ClientKeysManager
DDLManager
EmailSettingsManager
EmailTemplateManager
ExecutionLogsChannel
FluxbaseAdmin
FluxbaseAdminAI
FluxbaseAdminFunctions
FluxbaseAdminJobs
FluxbaseAdminMigrations
FluxbaseAdminRealtime
FluxbaseAdminRPC
FluxbaseAdminStorage
FluxbaseAI
FluxbaseAIChat
FluxbaseAuth
FluxbaseBranching
FluxbaseClient
FluxbaseFetch
FluxbaseFunctions
FluxbaseGraphQL
FluxbaseJobs
FluxbaseKnowledgeBase
FluxbaseManagement
FluxbaseOAuth
FluxbaseRealtime
FluxbaseRPC
FluxbaseSettings
FluxbaseStorage
FluxbaseTenant
FluxbaseVector
ImpersonationManager
InvitationsManager
OAuthProviderManager
QueryBuilder
RealtimeChannel
SchemaQueryBuilder
SecretsManager
ServiceKeysManager
SettingsClient
StorageBucket
SystemSettingsManager
WebhooksManager
functions
assertType
bundleCode
createClient
hasPostgrestError
isArray
isAuthError
isAuthSuccess
isBoolean
isFluxbaseError
isFluxbaseSuccess
isNumber
isObject
isPostgrestSuccess
isString
loadImportMap
interfaces
AcceptInvitationRequest
AcceptInvitationResponse
AddDocumentRequest
AddDocumentResponse
AdminAuthResponse
AdminBucket
AdminListBucketsResponse
AdminListObjectsResponse
AdminLoginRequest
AdminMeResponse
AdminRefreshRequest
AdminRefreshResponse
AdminSetupRequest
AdminSetupStatusResponse
AdminStorageObject
AdminUser
AIChatbot
AIChatbotLookupResponse
AIChatbotSummary
AIChatClientMessage
AIChatEvent
AIChatOptions
AIChatServerMessage
AIConversation
AIConversationMessage
AIDailyQuotaSnapshot
AIEntity
AIEntityRelationship
AIMatchedIntentRule
AIProvider
AIQuota
AIUsageStats
AIUserConversationDetail
AIUserConversationSummary
AIUserMessage
AIUserQueryResult
AIUserUsageStats
ApplyMigrationRequest
ApplyPendingRequest
AppSettings
AssignAdminOptions
AuthConfig
AuthenticationSettings
AuthResponse
AuthSession
AuthSettings
Branch
BroadcastMessage
BundleOptions
BundleResult
CaptchaConfig
ChatbotKnowledgeBaseLink
ChatbotSpec
ChunkedUploadSession
ClientKey
Column
CreateAIProviderRequest
CreateClientKeyRequest
CreateClientKeyResponse
CreateColumnRequest
CreateFunctionRequest
CreateInvitationRequest
CreateInvitationResponse
CreateKnowledgeBaseRequest
CreateMigrationRequest
CreateOAuthProviderRequest
CreateOAuthProviderResponse
CreateSchemaRequest
CreateSchemaResponse
CreateSecretRequest
CreateServiceKeyRequest
CreateTableRequest
CreateTableResponse
CreateTenantOptions
CreateToolIntegrationRequest
CreateUserSettingRequest
CreateWebhookRequest
DeleteClientKeyResponse
DeleteDocumentsByFilterRequest
DeleteDocumentsByFilterResponse
DeleteOAuthProviderResponse
DeleteTableResponse
DeleteUserResponse
DeleteWebhookResponse
DeprecateServiceKeyRequest
DownloadOptions
DownloadProgress
EdgeFunction
EdgeFunctionExecution
EmailProviderSettings
EmailSettingOverride
EmailSettings
EmailTemplate
EmbedRequest
EmbedResponse
EnableRealtimeRequest
EnableRealtimeResponse
EnrichedUser
ExecutionLog
ExecutionLogConfig
ExecutionLogEvent
FeatureSettings
FileObject
FluxbaseClientOptions
FluxbaseError
FunctionInvokeOptions
FunctionSpec
GetImpersonationResponse
GraphQLError
GraphQLErrorLocation
GraphQLRequestOptions
GraphQLResponse
HealthResponse
ImpersonateAnonRequest
ImpersonateServiceRequest
ImpersonateUserRequest
ImpersonationSession
ImpersonationTargetUser
IntrospectionDirective
IntrospectionEnumValue
IntrospectionField
IntrospectionInputValue
IntrospectionSchema
IntrospectionType
IntrospectionTypeRef
Invitation
InviteUserRequest
InviteUserResponse
Job
KnowledgeBase
KnowledgeBaseDocument
KnowledgeBaseSearchResult
KnowledgeBaseSummary
KnowledgeGraphData
LinkKnowledgeBaseRequest
ListBranchesResponse
ListClientKeysResponse
ListConversationsOptions
ListConversationsResult
ListEmailTemplatesResponse
ListImpersonationSessionsOptions
ListImpersonationSessionsResponse
ListInvitationsOptions
ListInvitationsResponse
ListOAuthProvidersResponse
ListOptions
ListRealtimeTablesResponse
ListSchemasResponse
ListSecretsOptions
ListSystemSettingsResponse
ListTablesResponse
ListUsersOptions
ListUsersResponse
ListWebhookDeliveriesResponse
ListWebhooksResponse
MailgunSettings
Migration
MigrationExecution
OAuthLogoutOptions
OAuthLogoutResponse
OAuthProvider
OAuthProviderInfo
OAuthProviderPublic
OrderBy
PostgresChangesConfig
PostgrestError
PostgrestResponse
PresenceState
ProviderTokenNotFoundError
ProviderTokenResponse
QueryFilter
RealtimeBroadcastPayload
RealtimeChangePayload
RealtimeChannelConfig
RealtimeMessage
RealtimePostgresChangesPayload
RealtimePresencePayload
RealtimeTableStatus
RequestOptions
ResetUserPasswordResponse
ResumableDownloadData
ResumableDownloadOptions
ResumableUploadOptions
ResumableUploadProgress
RevokeClientKeyResponse
RevokeInvitationResponse
RevokeServiceKeyRequest
RollbackMigrationRequest
RPCExecution
RPCExecutionFilters
RPCInvokeResponse
RPCProcedure
RPCProcedureSpec
RPCProcedureSummary
SAMLLoginOptions
SAMLLoginResponse
SAMLProvider
SAMLProvidersResponse
SAMLSession
Schema
SearchKnowledgeBaseRequest
SearchKnowledgeBaseResponse
Secret
SecretByNameOptions
SecretStats
SecretSummary
SecretVersion
SecuritySettings
SendGridSettings
ServiceKey
ServiceKeyWithKey
SESSettings
SignedUrlOptions
SignInCredentials
SignInWith2FAResponse
SignUpCredentials
SMTPSettings
StartImpersonationResponse
StopImpersonationResponse
StorageAdapter
StreamDownloadData
StreamUploadOptions
SubmitJobRequest
SyncChatbotsOptions
SyncChatbotsResult
SyncError
SyncFunctionsOptions
SyncFunctionsResult
SyncMigrationsOptions
SyncMigrationsResult
SyncRPCOptions
SyncRPCResult
SystemSetting
Table
TableColumn
TableDetails
TableForeignKey
TableIndex
Tenant
TenantAdminAssignment
TenantAdminWithUser
TenantEmailProviderSettings
TenantWithRole
TestEmailSettingsResponse
TestEmailTemplateRequest
TestToolIntegrationResult
TestWebhookResponse
ToolIntegration
TransformOptions
TwoFactorEnableResponse
TwoFactorSetupResponse
TwoFactorStatusResponse
TwoFactorVerifyRequest
UpdateAIProviderRequest
UpdateAppSettingsRequest
UpdateAuthSettingsRequest
UpdateAuthSettingsResponse
UpdateChatbotKnowledgeBaseRequest
UpdateClientKeyRequest
UpdateConversationOptions
UpdateDocumentRequest
UpdateEmailProviderSettingsRequest
UpdateEmailTemplateRequest
UpdateFunctionRequest
UpdateKnowledgeBaseRequest
UpdateMigrationRequest
UpdateOAuthProviderRequest
UpdateOAuthProviderResponse
UpdateRealtimeConfigRequest
UpdateRPCProcedureRequest
UpdateSecretRequest
UpdateServiceKeyRequest
UpdateSystemSettingRequest
UpdateTenantOptions
UpdateToolIntegrationRequest
UpdateUserAttributes
UpdateUserRoleRequest
UpdateWebhookRequest
UploadDocumentResponse
UploadOptions
UploadProgress
UpsertOptions
User
UserSetting
UserSettingWithSource
ValidateInvitationResponse
VectorOrderOptions
VectorSearchOptions
VectorSearchResult
WeakPassword
Webhook
WebhookDelivery
@nimbleflux/fluxbase-sdk
type-aliases
AIChatEventType
AIChatMessageRole
AIEntityType
AIProviderType
APIKey
AuthResponseData
BroadcastCallback
CaptchaProvider
CreateAPIKeyRequest
CreateAPIKeyResponse
DataResponse
DeleteAPIKeyResponse
DocumentStatus
EmailTemplateType
ExecutionLogCallback
ExecutionLogLevel
ExecutionType
FilterOperator
FluxbaseAuthResponse
FluxbaseResponse
HttpMethod
ImageFitMode
ImageFormat
ImpersonationType
IntegrationProvider
IntegrationType
ListAPIKeysResponse
OrderDirection
PresenceCallback
RealtimeCallback
RevokeAPIKeyResponse
RPCExecutionLog
RPCExecutionStatus
SessionResponse
StorageObject
TenantStatus
UpdateAPIKeyRequest
UserResponse
VectorMetric
VoidResponse
variables
APIKeysManager
denoExternalPlugin
React SDK
functions
FluxbaseProvider
isCaptchaRequiredForEndpoint
useAddDocument
useAdminAuth
useAIChat
useApplyMigration
useAppSettings
useAuth
useAuthConfig
useBranches
useCancelJob
useCaptcha
useCaptchaConfig
useChatbots
useClientKeys
useConversation
useConversations
useCreateBranch
useCreateBucket
useCreateKnowledgeBase
useCreateSchema
useCreateSecret
useCreateServiceKey
useCurrentImpersonation
useDelete
useDeleteBranch
useDeleteBucket
useDeleteConversation
useDeleteDocument
useDeleteKnowledgeBase
useDeleteSecret
useDeleteTable
useFluxbaseClient
useFluxbaseQuery
useFunctions
useGetSAMLLoginUrl
useGraphQL
useGraphQLIntrospection
useGraphQLMutation
useGraphQLQuery
useHandleSAMLCallback
useImpersonateUser
useImpersonationSessions
useInsert
useInvokeFunction
useInvokeRPC
useJobs
useJobStatus
useKBDocuments
useKBEntities
useKBSearch
useKnowledgeBase
useKnowledgeBases
useKnowledgeGraph
useMigrations
useRealtime
useResetBranch
useRetryJob
useRevokeServiceKey
useRollbackMigration
useRotateServiceKey
useRPCList
useSAMLMetadataUrl
useSAMLProviders
useSchemas
useSecrets
useServiceKeys
useSession
useSignIn
useSignInWithSAML
useSignOut
useSignUp
useStopImpersonation
useStorageBuckets
useStorageDelete
useStorageDownload
useStorageList
useStoragePublicUrl
useStorageSignedUrl
useStorageSignedUrlWithOptions
useStorageTransformUrl
useStorageUpload
useStorageUploadWithProgress
useSubmitJob
useSyncMigrations
useSystemSettings
useTable
useTableDeletes
useTableDetails
useTableInserts
useTables
useTableSubscription
useTableUpdates
useTenant
useTenants
useUpdate
useUpdateKnowledgeBase
useUpdateSecret
useUpdateUser
useUploadDocument
useUpsert
useUser
useUsers
useVectorEmbed
useVectorSearch
useWebhooks
interfaces
AdminUser
AppSettings
AuthSession
CaptchaConfig
CaptchaState
ChatMessage
ClientKey
CreateTenantOptions
EnrichedUser
FluxbaseClient
GraphQLError
GraphQLErrorLocation
GraphQLRequestOptions
GraphQLResponse
PostgrestResponse
RealtimeChangePayload
SAMLLoginOptions
SAMLLoginResponse
SAMLProvider
SAMLProvidersResponse
SAMLSession
SignedUrlOptions
SignInCredentials
SignUpCredentials
SystemSetting
Tenant
TenantWithRole
TransformOptions
UpdateTenantOptions
UseBranchesOptions
UseCreateBranchParams
UseGraphQLMutationOptions
UseGraphQLQueryOptions
UseJobsOptions
User
UseTableDetailsOptions
UseTableDetailsReturn
UseTenantOptions
UseTenantReturn
UseTenantsOptions
UseTenantsReturn
Webhook
@nimbleflux/fluxbase-sdk-react
type-aliases
APIKey
CaptchaProvider
ImageFitMode
ImageFormat
StorageObject
variables
useAPIKeys
Svelte SDK
functions
appSettings
authConfig
branches
cancelJob
captchaConfig
createBranch
createCookieStorage
createSecret
deleteBranch
deleteSecret
fluxbaseQuery
functions
getClient
getQueryClient
graphqlMutation
graphqlQuery
insert
invokeFunction
invokeRPC
jobs
jobStatus
realtimeChannel
remove
rpcList
samlProviders
secrets
session
setFluxbaseClient
signIn
signInWithSAML
signOut
signUp
storageBuckets
storageDownload
storageList
storagePublicUrl
storageRemove
storageUpload
submitJob
systemSettings
table
tableDeletes
tableInserts
tableUpdates
update
updateSecret
updateUser
upsert
user
users
vectorEmbed
vectorSearch
webhooks
interfaces
AuthSession
Branch
CookieStorageOptions
FluxbaseClient
FluxbaseQueryOptions
Job
ListBranchesResponse
QueryBuilder
SignInCredentials
SignUpCredentials
StorageAdapter
StoreDeps
SvelteKitCookies
User
@nimbleflux/fluxbase-sdk-svelte
type-aliases
FluxbaseResponse
Next.js SDK
functions
createCookieStorage
createServerClient
FluxbaseProvider
useFluxbaseClient
interfaces
CookieStorageOptions
CreateServerClientOptions
FluxbaseClient
FluxbaseProviderProps
NextCookies
StorageAdapter
@nimbleflux/fluxbase-sdk-next
Vue SDK
functions
createCookieStorage
useFluxbaseClient
interfaces
CookieStorageOptions
FluxbaseClient
NuxtCookieEvent
StorageAdapter
@nimbleflux/fluxbase-sdk-vue
variables
FLUXBASE_CLIENT_KEY
HTTP API
GraphQL API
Pricing
AI & Development Transparency
GitHub
Discord
Select theme
Dark
Light
Auto
InviteUserRequest
Properties
Section titled “Properties”
Property
Type
email
string
role?
string
send_email?
boolean
