Skip to main content

​
Base URL and auth

Authenticate with a Bearer API key from your Developer settings:
The key acts as you, so it can only see and change workspaces you have access to, and every change is attributed to you in the app’s version history.
The build endpoints are free for 14 days, starting on your first build call. After that they’re on the Business plan and above, and an unentitled key gets a 402.

​
The lifecycle

1

Create a workspace

A database plus the apps built on it. See Create a workspace.
2

Open a build session

An isolated checkout where you create apps and edit files. See Open a session.
3

Create an app and write code

Scaffold, edit, check, iterate. See Create an app.
4

Commit

Builds a versioned snapshot in the background. See Commit.
5

Deploy and observe

Publish the build live and pull logs. See Publish a deployment.

​
Relationship to the Zite MCP

Same operations and semantics as the Zite MCP build tools, where a session maps to a sandbox. Use the MCP for interactive agents, the Build API for CI, scripts, and automation.

​
Conventions

​
Errors

Every error returns the same envelope:

​
Async builds

commit and publish kick off builds in the background. Poll the app’s buildStatus (see Get an app) and wait for a green build before publishing. Publishing early returns a 400 explaining why.