Section
Developer Platform
Build against your SaaS with the app-scoped Developer API, webhooks, connectors, AI, logs, MCP tools, the CLI, and secure installed services.
One backend. Every way to build.
Build visually, use React, call the REST API, operate through the CLI, connect an AI through MCP, or install your own container service. Every path uses the same tenant identity, permissions, records, workflows, audit trail and application contract. Custom services reach platform records through the governed gateway, never a direct database shortcut.
Published Kit 1.20.70 contract: 422 public Developer API operations across 340 paths; 295 module operations; up to 43 permission-filtered MCP tools. Installed-service operations are dynamic per application. MCP compatibility and identity surfaces distinguish available features from planned extensions.
API MapRoute inventory for native modules, Developer API operations and Build This recipes.Download and update the developer kitUse one portable Developer Kit, then synchronize authorized account contracts inside its workspace.Developer platform overviewOne permission-aware developer surface for records, connectors, events, AI, logs, MCP, and installed services.Build a complete headless SaaSUse published first-class module operations from your own React, mobile, desktop, or legacy interface without exposing an API credential to the browser.How customer organizations can signup from your websiteConnect your SaaS marketing-site signup and login to one governed BuildWithHQ customer organization and its first owner.Build This API recipesEighteen complete, contract-backed API slices for BuildWithHQ and API43 product concepts.Developer API quickstartCreate an app-scoped credential, verify its identity, make a first record request, and retain correlation evidence.REST APIsThe current resource-oriented v1 API for app identity, records, connectors, webhooks, AI, logs, contracts, and installed services.Authentication and API clientsUse isolated draft credentials for unpublished page JSON and an explicit live credential for publication and production operations.Requests, responses, errors, and correlation IDsThe conventions every client should apply for JSON, pagination, safe errors, retries, and operational evidence.Permission-aware data accessEvery data surface resolves through the same record, role, location, and capability envelope.Connectors, OAuth, and provider secretsDiscover supported connector types and configure data, payment, and OAuth connections without sending raw provider secrets.Inbound endpointsCreate app-bound inbound entry points, rotate keys, and process incoming events through authenticated application APIs.Webhooks and event deliveryPush signed application events to external systems with retries, idempotency, and observable delivery history.Webhook receiver and background-job polling examplesRun the exact-body webhook receiver and bounded AI rebuild poller published at webhooks.buildwithhq.com.Logs, diagnostics, and correlation tracingTail and search bounded app logs, then follow one correlation ID across related operational evidence.AI ingestion, rebuilds, and multimodal searchUse the secured tenant AI surface for authorized record ingestion, rebuild operations, and Qwen3-VL search.Workflows and custom actionsBuild durable server-side automations from native actions, approvals, waits, webhooks, AI actions, and extension services.MCP tools for AI clientsExpose approved API-backed application capabilities to MCP-compatible AI clients under the same permission envelope.Use BuildWithHQ with DeepSeek HarnessConnect DeepSeek Harness to the curated BuildWithHQ MCP surface with a tested Streamable HTTP patch, app or delegated-user identity, and exact tool-name mapping.Marketplace service API discoveryDiscover installed custom endpoint schemas, download per-app OpenAPI, and let MCP agents plan governed calls.Extensible container servicesAdd custom code in an isolated container, then expose it through declared endpoints the BuildWithHQ runtime can safely invoke.BuildWithHQ CLIUse the shipped .NET 10 CLI for profiles, app delivery, templates, services, API clients, workers, AI, and logs.Interactive API referenceSearch and inspect every public BuildWithHQ operation from the current generated OpenAPI contract.OpenAPI, versioning, and SDKsKeep the API reference, schemas, generated clients, and changelog synchronized from one canonical contract.Progressive loading, fast rows, and exact countsRender authorized rows immediately, then fill in an independently requested full count without confusing a browse limit with the size of an organization.Pagination, filtering, rate limits, and versioningImplement list traversal, server-side filters, 429 recovery, and contract pinning from the exact OpenAPI operation.Limits, rate limits, and idempotencyHow clients should handle quotas, throttling, payload boundaries, retries, and safely repeated writes.Integration go-live checklistA practical review for credentials, scopes, retries, webhooks, observability, test isolation, and operational ownership.Email and SMS support lanesManage organization-owned receiving channels through a secured API and editable React page.Outside form submissionsConfigure tenant-owned form endpoints and receive server or browser submissions in Universal Inbox.Current API contracts and error handlingKit 1.20.70: exact public API contracts, SDK packaging, webhook errors and shared AI routes.Builder Platform APIUse the 129-operation owner API for app, account, operations, diagnostics and BuildSpec workflows.Connect organization logs to SnowflakeSet up, verify, operate and troubleshoot organization log export with Snowpipe Streaming.