Documentation

Written once, for people and machines

Every page here is a markdown file in /docs. This site renders them; it is not where they live. Edit the file and the page follows.

Start here

1 page
QuickstartFrom a new account to your first successful API call, in about two minutes.building

Auth API

16 pages
Auth APIEvery endpoint, one page each, with the request and response it actually returns.building
Sign upCreate an account with a six-digit code emailed to the address. No password needed.building
Sign inSign somebody in with a code or a password, read the session back, and end it.building
Verify emailConfirm an address, and send the link again when the first one never arrives.building
Reset a passwordThe forgotten-password flow, enumeration-resistant at both ends.building
Social loginGoogle and GitHub with your own OAuth app — configure, list, disconnect, and sign in.building
Two-factorTOTP and single-use recovery codes. Enable, verify, and what sign-in returns once it is on.building
PasskeysWebAuthn sign-in, bound to your domain rather than ours — and what that constrains.building
OrganizationsWorkspaces inside your app — create them, set roles, invite people, and fill in org_id.building
Enterprise SSOOIDC and SAML 2.0, registered by your customers themselves, with users joining an organization on arrival.building
Directory syncSCIM provisioning — issue a directory a credential, and let it create and deactivate people.building
Get usersList the accounts in a project, newest first, with a cursor and a last-seen time.building
Delete usersTwo ways, because they are two different actions — the person leaving, and you removing them.building
SettingsWhat is fixed by convention, what you still decide per project, and how to change it.building
Tokens and JWKSA short-lived JWT your API verifies locally, so we are not a hop on every request you serve.building
Limits and statesTwo rate limits answering different questions, and what a project still being provisioned returns.building

Files API

9 pages
Files APIEvery endpoint, one page each, with the request and response it actually returns.building
Upload filesOne operation, three calls — get a URL, send the bytes, confirm they landed.building
Get filesList and filter, or fetch one by id. Every result carries its URLs already.building
Update filesChange visibility, ownership, position or transform settings — and what moves when you do.building
Delete filesOne file, or everything attached to one of your objects.building
Restoring a deleted fileDeletes are reversible for 30 days — how to see what is recoverable and bring it back.building
Signed URLsPrivate files expire after five minutes. How to get a fresh set, and when not to.building
The file objectEvery field a file response carries, and which ones can be absent.building
Limits and formatsSizes, expiries, widths, and every accepted content type.building

Data API

10 pages
DatabaseA Postgres database of your own, created in seconds, with a connection string you paste into your app.building
Create a databaseWhat you get, where it lives, and what starts costing money.building
ConnectingTwo connection strings, which one to use, and the settings that matter.building
Connection detailsFetch the connection strings from your deployment pipeline instead of pasting them.building
Running migrationsWhich endpoint to point your migration tool at, and why it matters.building
Sleeping and wakingScale to zero, what the first query after a quiet spell costs, and what that saves.building
Replacing the passwordRotation, what it breaks, and what to do when a string gets away from you.building
Limits and what is not hereQuotas, what suspension looks like, and the features we have not built yet.building
Branches and browsingCopy your database in a second, and look inside it from the studio.building
Backups and restoreThere are no backups. There is a week of history and a restore that takes seconds.building

Platform

3 pages
What xplatform isA control plane that provisions independent services into a project, and the reasoning behind that shape.building
Usage and billingHow services report what they used, why gauges and counters need different plumbing, and how limits are enforced.building
Operating itScheduled jobs, how a failure surfaces, and the one endpoint a monitor should watch.building

For machines

The same docs, without the chrome

An AI reading these should not have to strip HTML or run JavaScript. Three plain-text surfaces, served from the same markdown as the pages above, so they cannot drift apart.

/docs/llms.txtAn index: what this is, and one line per page. A few hundred tokens, enough to decide what to fetch.
/docs/llms-full.txtAll 39 pages concatenated, each labelled with its source path.
/docs/raw/{path}Any single page as raw markdown.