This page is part of an AI coding agent skill and is written for agents, not humans. For the human-readable Base44 docs, see the developer documentation.

Base44 SDK Quick Reference

Compact method signatures for all SDK modules. Verify against this before writing code.

Auth (`base44.auth.*`)

loginViaEmailPassword(email, password, turnstileToken?) → Promise<{access_token, user}>
loginWithProvider('google' | 'microsoft' | 'facebook', fromUrl?) → void
me() → Promise<User | null>
updateMe(data) → Promise<User>
isAuthenticated() → Promise<boolean>
logout(redirectUrl?) → void
redirectToLogin(nextUrl) → void              # ⚠️ Avoid - prefer custom login UI
register({email, password, turnstile_token?, referral_code?}) → Promise<any>
verifyOtp({email, otpCode}) → Promise<any>
resendOtp(email) → Promise<any>
inviteUser(userEmail, role) → Promise<any>
resetPasswordRequest(email) → Promise<any>
resetPassword({resetToken, newPassword}) → Promise<any>
changePassword({userId, currentPassword, newPassword}) → Promise<any>
setToken(token, saveToStorage?) → void

Entities (`base44.entities.EntityName.*`)

create(data) → Promise<T>
bulkCreate(dataArray) → Promise<T[]>
list(sort?, limit?, skip?, fields?) → Promise<Pick<T, K>[]>
filter(query, sort?, limit?, skip?, fields?) → Promise<Pick<T, K>[]>
get(id) → Promise<T>
update(id, data) → Promise<T>
updateMany(query, mongoUpdateOp) → Promise<UpdateManyResult>   // e.g. { $set: { field: val } }
bulkUpdate(dataArray) → Promise<T[]>                           // each item must have id
delete(id) → Promise<DeleteResult>
deleteMany(query) → Promise<DeleteManyResult>
importEntities(file) → Promise<ImportResult<T>>                // frontend only
subscribe(callback) → () => void                               // returns unsubscribe fn

Sort: Use SortField<T>: -fieldName for descending (e.g., -created_date). Max 5,000 per request for list/filter.

Functions (`base44.functions.*`)

invoke(functionName, data?) → Promise<AxiosResponse>  // your JSON is on .data; throws on non-2xx (err.response.data)
fetch(path, init?) → Promise<Response>   // low-level, for streaming/custom methods

Backend: Use base44.asServiceRole.functions.invoke() for admin access.

Integrations (`base44.integrations.Core.*`)

InvokeLLM({prompt, add_context_from_internet?, response_json_schema?, file_urls?}) → Promise<string | object>
GenerateImage({prompt}) → Promise<{url}>
GenerateSpeech({text, voice?, language_code?}) → Promise<{url}>   // stored MP3; voices river (default), honey, sunny, storm, spark; ≤5,000 chars
SendEmail({to, subject, body, from_name?}) → Promise<any>
UploadFile({file}) → Promise<{file_url}>
UploadPrivateFile({file}) → Promise<{file_uri}>
CreateFileSignedUrl({file_uri, expires_in?}) → Promise<{signed_url}>
ExtractDataFromUploadedFile({file_url, json_schema}) → Promise<object>

AI surface: single call, no tools → InvokeLLM; chat product for users → base44.agents; task-with-tools agent (code) → aiGateway; one default image → GenerateImage; simple text-to-video → GenerateVideo; multiple/configured/edited images or advanced video → aiGateway; text-to-speech → browser/Core/gateway selection; classify/score/route → aiGateway Jev (see below).

AI Gateway (`base44.asServiceRole.aiGateway.*`)

asServiceRole.aiGateway.connection({ provider?: "openai" | "typesafe" }) → { baseURL, token, headers }   // backend only; always pass headers
aiGateway.connection(options?) → same, caller's token — browser/user-token calls get 403 ai_gateway_requires_service_role (private/workspace apps excepted)

openai (default): chat completions for code agents (model automatic by default), images.generate / images.edit, async videos.create / videos.retrieve (specific model required), and audio.speech.create (completed audio bytes; see speech guide).
typesafe: experimental_evaluate (ai 7.0.105+) with typesafe.evaluationModel("jev") for classify/score/route decisions.
Set maxRetries: 0 on image, video, speech, and evaluation calls. See ai-gateway.md.

Custom Integrations (`base44.integrations.custom.*`)

call(slug, operationId, {payload?, pathParams?, queryParams?}?) → Promise<{success, status_code, data}>

operationId format: "method:/path" (e.g., "get:/contacts", "post:/users/{id}")

Analytics (`base44.analytics.*`)

track({eventName, properties?}) → void

App Logs (`base44.appLogs.*`)

logUserInApp(pageName) → Promise<void>
fetchLogs(params?) → Promise<any>
getStats(params?) → Promise<any>

Users (`base44.users.*`)

inviteUser(userEmail, role) → Promise<any>    // role: 'user' | 'admin'

Service Role Connectors (`base44.asServiceRole.connectors.*`)

Backend only, service role required. App-scoped (shared account).

getConnection(integrationType) → Promise<{accessToken, connectionConfig}>   // recommended
getAccessToken(integrationType) → Promise<string>                           // deprecated

Types: Run npx base44 connectors list-available to see all available integration types.

SSO (`base44.asServiceRole.sso.*`)

Backend only, service role required.

getAccessToken(userId) → Promise<{access_token}>
getIdToken(userId)     → Promise<string>             // raw ID token; use for identity claims, especially email

getIdToken returns the current app user’s OIDC ID token as a raw string, and the service-role client must act on behalf of the same user.

Service Role Access

Backend functions only. Prefix any module with asServiceRole for admin access:

base44.asServiceRole.entities.Task.list()
base44.asServiceRole.functions.invoke('name', data)
base44.asServiceRole.connectors.getConnection('slack')
base44.asServiceRole.sso.getAccessToken(userId)
base44.asServiceRole.sso.getIdToken(userId) // current app user only; use for the email claim

Backend Function Template

import { createClientFromRequest } from "@base44/sdk";

export default async function (req) {
  const base44 = createClientFromRequest(req);
  const data = await req.json();
  
  // User context
  const user = await base44.auth.me();
  
  // Service role for admin operations
  const allRecords = await base44.asServiceRole.entities.Task.list();
  
  return Response.json({ success: true });
}

Client Initialization (External Apps)

import { createClient } from "@base44/sdk";

const base44 = createClient({ appId: "your-app-id" });  // MUST use 'appId'

TypeScript type registries

For typed entities, function names, and agent names (autocomplete and type checking), the Base44 CLI generates types and wires them into your project. Use the base44-cli skill for how to generate types.

​Base44 SDK Quick Reference

​Auth (base44.auth.*)

​Entities (base44.entities.EntityName.*)

​Functions (base44.functions.*)

​Integrations (base44.integrations.Core.*)

​AI Gateway (base44.asServiceRole.aiGateway.*)

​Custom Integrations (base44.integrations.custom.*)

​Analytics (base44.analytics.*)

​App Logs (base44.appLogs.*)

​Users (base44.users.*)

​Service Role Connectors (base44.asServiceRole.connectors.*)

​SSO (base44.asServiceRole.sso.*)

​Service Role Access

​Backend Function Template

​Client Initialization (External Apps)

​TypeScript type registries

Base44 SDK Quick Reference

Auth (`base44.auth.*`)

Entities (`base44.entities.EntityName.*`)

Functions (`base44.functions.*`)

Integrations (`base44.integrations.Core.*`)

AI Gateway (`base44.asServiceRole.aiGateway.*`)

Custom Integrations (`base44.integrations.custom.*`)

Analytics (`base44.analytics.*`)

App Logs (`base44.appLogs.*`)

Users (`base44.users.*`)

Service Role Connectors (`base44.asServiceRole.connectors.*`)

SSO (`base44.asServiceRole.sso.*`)

Service Role Access

Backend Function Template

Client Initialization (External Apps)

TypeScript type registries