Skip to content
BuildBase
HTTP API menu

HTTP API reference

Every operation of the BuildBase HTTP API, by tag, generated from its OpenAPI description: method, path, sign-in, fields, answers and errors.

The API your app and @buildbase/sdk call: hosted sign-in, OAuth 2.0, and the session API that acts as one signed-in user of your app.

618 operations in 42 groups. 204 are fully described; the others have a page that says what is still missing.

Where to send requests

ServerURL
BuildBase cloudhttps://api.console.buildbase.app
A self-hosted install{serverUrl}

How a request signs in

Each operation page says which of these it needs.

CredentialHow to send itWhat it is
loginTokenAuthorization: Bearer ...An app end user's login token from hosted sign-in, for the same org as the request.
orgQuerythe org query parameterThe org id the request is for, when there is no sign-in state. Not a credential.
sessionIdthe x-session-id headerAn end user's session id, as the SDK sends it. POST /api/v1/public/token/exchange issues one for an org API token.
signInStatethe state headerThe hosted sign-in state id. Names the org the request is for; not a credential.

Operations by tag

For tools and agents

  • The OpenAPI description these pages come from: public-v1.json
  • Every fully described operation, one line each: llms/http-api.txt
  • Any page as Markdown: its URL with .md added