Skip to main content
Platform API Docs

Concepts and Request Contract

Understand gateway identity, operation binding, environments, visibility, and the canonical request envelope.

Version Public contract v1 Generated references follow approved public contract hashes Reviewed Jul 26, 2026 Next review Oct 26, 2026

The free Developer workspace is for non-production building and learning under published limits. External API or MCP client credentials use a separate scoped request and approval process.

Owner: Batoi Developer Experience Reviewed by: Batoi Platform Security Source revision: upgrade-jul-26-2026

Browse Batoi Platform API Documentation Concepts and Request Contract

Concepts and Request Contract

Objects

  • A gateway is the logical API product owned in Build.
  • An operation is one reviewed capability with strict request and response schemas.
  • A contract version is an immutable compilation of approved operations.
  • A publication activates one contract version for one environment and visibility.
  • A client binding joins one registered client to one gateway, environment, audience, and scope set.

Envelope

Every new public client sends:

FieldMeaning
contractMust be batoi.public-api/1.
gatewayPublished gateway UID fixed by the client binding.
operationOperation key contained in the active contract.
environmentsandbox, beta, or production; must match the binding.
methodLogical method recorded in the operation contract.
requestStrict JSON object validated against the operation schema.

The caller cannot choose an internal route, table, workspace, Project, App, target URL, or handler. Those bindings are private compiler inputs.

Fail-closed behavior

An operation is unavailable when it is absent from the active contract, its schema hash differs, its publication expired or was revoked, its environment or audience differs, or the client lacks its scope.