Last updated

Glossary

Mirrored from iblai/vibe Β· docs/glossary.md. This page is generated β€” edit it in the repository, not here.

The words used across iblai/vibe (both skill families), iblai/os, and the platform itself. When a term has several spellings on the wire, the Meaning column is what to say in prose and the On the wire / in code column is what to keep verbatim in code, env files, and endpoint references.

Prose uses organization / org key, agent, and user. The words tenant, mentor, and learner are wire names only β€” write them in backticks, in code, env files, and endpoint references, and nowhere else.

TermMeaningOn the wire / in code
PlatformThe ibl.ai system as a whole β€” api.iblai.app, login.iblai.app, os.ibl.ai. One platform serves every customer.Product terms only: "Platform API Token", "the platform API"
Organization (org)One customer's isolated workspace: its users, agents, branding, data, and credits. The primary noun for a workspace.platform_key, platform_org, org, tenant; SDK/env: NEXT_PUBLIC_MAIN_TENANT_KEY, localStorage.tenants
Org keyThe organization's identifier β€” a slug like acme or a UUID. Listed on login.iblai.app/me and in every os.ibl.ai/platform/<org-key>/… URL.PLATFORM in iblai.env; IBLAI_ORG for the iblai-api-* skills
mainThe shared default org every account belongs to. It is never your org; apps refuse it.PLACEHOLDER_PLATFORMS in lib/iblai/tenant.ts
Member / userA signed-in person who belongs to the org.is_admin: false on the org's entry in localStorage.tenants
AdminA member holding the org's Admin role β€” every policy implicitly. Manages users, roles, billing, memory, branding.is_admin: true; isTenantAdmin() in the app; Ibl.* in RBAC
AgentA configured AI assistant: LLM, prompts, datasets (RAG), tools, memory, safety, voice. What the API calls a mentor.mentor, mentor_unique_id, mentor_id (numeric), the UUID at the end of os.ibl.ai/platform/<org-key>/<agent-uuid>
Platform API TokenA server-side secret scoped to one org. Sent as Authorization: Api-Token <token> on every REST call; also a standard OpenAI-style Bearer key on the OpenAI-compatible /v1 endpoints. Minted in os.ibl.ai (Admin β†’ Integrations β†’ APIs β†’ Add API) or by /iblai-api-login. An org secret works as one too.TOKEN in iblai.env, IBLAI_API_KEY in .env.local β€” never in client code
Session tokensBrowser-side tokens the SSO flow issues for the signed-in user: axd_token, dm_token, edx_jwt_token, plus userData and tenants. Sent as Authorization: Token <dm_token> by the SDK.localStorage (see security-model.md)
User metadataOne schemaless JSON object per user Γ— org β€” preferences, flags, onboarding progress, app state.GET/PATCH/PUT/DELETE …/dm/api/core/users/platform-metadata/?platform_key=
Org metadataOne JSON object per org holding the OS's own settings (default agent, help center, auth-page branding, toggles) and your app's keys. Public read; PUT replaces the whole object β€” always GET, merge, PUT.GET/PUT …/dm/api/core/orgs/{org}/metadata/
MemoryWhat agents remember: global memories (per user, every agent), agent memories (per user Γ— agent, by category), agent knowledge (per agent, shared, injected as ## Agent Knowledge). Gated by the org flag enable_memsearch, the agent flag enable_memory_component, and the user's capture/recall toggles.global-memories, mentor-memories, agent-memories, memsearch-settings
CreditsThe prepaid, rechargeable balance the org's usage draws down. Plans: Free, Trial, Premium. Auto-recharge is opt-in; the balance is a hard ceiling.GET /dm/api/billing/account/
Spend capAn admin ceiling on LLM cost β€” org-wide, one agent, or one user on one agent β€” per day/week/month/year, enforced as block (HTTP 429) or alert only.…/spend-caps/tenant/, …/mentors/{mentor}/spend-cap/, …/spend-caps/users/{username}/
App paywallPay-to-enter for a whole app on the org's own Stripe key. No Stripe Connect, no commission, no webhooks./iblai-vibe-monetization-app-paywall
Monetization (Connect)Selling individual items (agents, courses, programs, custom) through Stripe Connect Express, with an ibl.ai commission./iblai-vibe-monetization*, enable_monetization
Allowed redirect originsThe origins SSO is permitted to return to after sign-in. Every origin your app runs on β€” http://localhost:3000, the deployed URL, a Tauri custom scheme β€” must be listed, or sign-in never comes back.An org-level setting maintained for your org by ibl.ai β€” if sign-in never returns to your app, this is the first thing to check; ask your ibl.ai operator to add the origin
Single-org appArchitecture A: an app for the members of one organization; the org key is pinned (NEXT_PUBLIC_MAIN_TENANT_KEY) and the server holds that org's Platform API Token. vibe-starter as shipped.ARCHITECTURE=single-org in iblai.env
Multi-org appArchitecture B: one deployment, many organizations; the org comes from the URL, users switch orgs and re-authenticate per org (the os.ibl.ai model).ARCHITECTURE=multi-org; /platform/[org]/…
HeadlessArchitecture C: no sign-in β€” a script, CI, or backend using a Platform API Token; the iblai-api-* skills.ARCHITECTURE=headless
Public agentAn agent reachable without an account (allow_anonymous, or visibility viewable_by_anyone); its route is left out of AuthProvider's protection; the user is anonymous.ACCESS=public
Visiting orgA signed-in user of org A opening an agent in org B; stored as visiting_tenant; org-scoped calls may 401.useVisitingTenant()
Org lockA Tauri build pinned to one org at build time (IBL_TENANT): anonymous users go straight into it, users of other orgs are switched.useTenantLock() in the OS
DMThe Data Manager service behind api.iblai.app/dm/… β€” agents, memory, analytics, billing, RBAC, metadata.dmUrl() in lib/iblai/config.ts
LMSThe Open edX service behind api.iblai.app/lms/… and learn.<domain> β€” courses, the user's account record (name, bio, image).lmsUrl(), legacyLmsUrl()
vibe-starterThe Next.js template /iblai-vibe-ops-init copies into a new project: SSO, navbar, chat, agents, profile, admin area, metadata helpers.skills/start/iblai-vibe-ops-init/assets/vibe-starter/

Copyright Β© ibl.ai | support@iblai.zendesk.com