Skip to main content

Contracts and schema downloads

These downloads are copied byte-for-byte from the repository's contract owners when the handbook is built. Use the matching source revision and current definition when implementing an integration. A downloaded schema describes shape; it does not provide authorization or prove an operation can execute. See versioning and hard cutovers.

HTTP and reactive descriptions​

DescriptionDownloadUsage
Application Serving OpenAPIserving.openapi.jsonServing HTTP
Board OpenAPIboard.openapi.jsonBoard API
Reactive AsyncAPIreactive.asyncapi.jsonReactive channels

The reference pages render operations, messages and field tables from these same sources. They do not collect credentials or send live requests.

Native messages and configuration​

DescriptionDownloadExact contract
Native protocol typestransit-v1.schema.jsonNative v1, signed HTTP
SQL session routes and messagessql-session-v1.schema.jsonSQL sessions
Table mediation messagestable-service-v1.schema.jsonTable service
Configuration service messagesconfiguration-v1.schema.jsonConfiguration
Setting keys, defaults and boundsconfiguration-settings-v1.jsonConfiguration reference
Structured diagnosticsdiagnostic-v1.schema.jsonDiagnostics
Application installationapplication-installation-v1.schema.jsonInstallation

These are native schema documents, not OpenAPI routes. Follow each owner's encoding, canonicalization and compatibility rules in addition to validating message structure. Fixed byte arrays, signed values and logical SQL cells must retain their specified representation.

Wire specifications, signing fixtures, SDK ABI declarations, SQL grammars and upstream protocol pins remain in the contract directory. The interface map connects each public surface to its usage reference and internals. Generated files are updated by their owners; the site does not maintain an independent protocol definition.