Endpoint Reference

The complete Backbuild REST API, grouped by domain. Every endpoint below is generated from the machine-readable OpenAPI 3.1 specification (1251 operations across 18 domains), so it always matches the deployed contract: request and response fields, types, authentication, and error codes.

Prefer a guide? The curated API Reference overview walks through the envelope, authentication, and common patterns. Download the raw spec: backbuild-api.json.

Admin & Security Organization security, access control, and administration: the security overview, audit events and alerts, data-subject-access requests, consent and privacy controls, role-based access control (roles, permissions, policies, departments, and groups), alert rules, and the project-management surface (specs, tasks, categories, and phases). (68 endpoints) AI Assistant Manage AI assistant sessions, conversations, messages, cost tracking, multi-environment access matrices, sharing, AI model and provider configuration, finite-state-machine skills, multi-agent engine sessions, global system prompts, and the vision-verdict endpoint. (54 endpoints) AI Testing, Search & Indexing Semantic/vector search over indexed documents, natural-language and hybrid (dense + ColBERT) retrieval, the AI test center (scenarios/personalities/test-data assets + runs), vector-index benchmarking, content-indexing status, and the in-app training & courseware platform. (37 endpoints) Authentication Account registration, login, OAuth, password reset, token refresh, session lifecycle, MFA, and OAuth device-authorization for CLI/MCP clients. (55 endpoints) Prove, Science & Studio Solver-DAG operations and theorem authoring, proof browser and artifact graph, kernel-run logs, submission pipeline, and webhook delivery audit for Backbuild Prove. (166 endpoints) Billing & Subscriptions Manage subscriptions, invoices, payment methods, checkout sessions, credit packs, pricing plans, API keys, Stripe Connect profiles, and academic verification flows for Backbuild and Backbuild Science. (50 endpoints) Chat Backbuild Chat: channels and direct and group conversations, members, messages with edits, reactions and pins, delivery and read receipts, the people you chat with, and file attachments. Message bodies are end-to-end encrypted: the API carries sealed envelopes that members' devices open, never plaintext. (35 endpoints) Communications & Productivity Mailbox, messaging, domain management, calendar, scheduling, and email-list management for Backbuild organizations. (201 endpoints) Remote Hosts Run your organization's containers and virtual workers on machines you own: add hosts with a one-step pairing command or an approval, drain and revoke them, place workers on hosts or host groups, and manage the hosts' firewall rules, managed operating-system accounts and agent updates. Sending ad hoc jobs straight to a host is not available yet. (29 endpoints) Containers & Virtual Workers Provision and manage multi-cloud AI-agent containers, Virtual Workers, terminal sessions, sandbox environments, and the code-API tool-bridge used by in-container agents to act on behalf of the authenticated user. (74 endpoints) Files & Documents File-bridge relay (WebSocket), BBProve confined source read/write, document library management, BB Docs collaborative editor, document comments and shares, resource versioning, and Science artifact promotion. (41 endpoints) Organizations & Users Org-scoped administrative surfaces: per-key settings toggles, custom-domain lifecycle, control policies, URL-slug availability, visibility rules, bootstrap context, CCPA consumer-privacy rights, and legal-agreement signing. (55 endpoints) Projects, Entities & Data Model Manage project CI/CD pipelines, logical environments, project templates, entities and entity types, entity media, entity relationships and relationship types, entity permission grants, and saved views. (72 endpoints) Projects Create and manage projects: the primary workspace unit that groups entities, files, tasks, and views within an organization. The organization is taken from the authenticated session; callers never pass `org_id`. Identifiers and timestamps are assigned by the platform. (9 endpoints) Releases & Automation Manage SaaS package release lifecycle, desktop distribution, container deployments, feature flags, campaigns, automation rules, time triggers, workflows, and change management. (95 endpoints) SaaS Builder Create and publish SaaS packages: define pricing plans, branding, custom domains, marketing pages, seed data, screen definitions, app configs, feature flags, AI model overrides, data bundles, promotions, connector configs, and integrations for packages built on the Backbuild platform. (159 endpoints) Sheets, Slides & Collaboration BB Sheets (spreadsheets) with cell comments, BB Slides decks, the collaboration and realtime Yjs WebSocket transports, and offline sync. (21 endpoints) SSO & SCIM Enterprise SAML 2.0 / OIDC single sign-on, the authenticated SSO config admin surface, and SCIM 2.0 user provisioning. (30 endpoints)