DocumentationReference
On this page

Technical contracts

Find exact schemas and protocols for authoring, execution, deployment, and integrations.

Use the linked source contracts for exact fields, bounds, and protocol behavior. These references are pinned to the release used by the documentation examples.

Authoring

The Control API defines node discovery, reads, edits, validation, publication, Runs, workflow files, and input sources. The node authoring guide explains how business configuration becomes the product’s execution definition.

An agent should discover the current deployment’s schema and catalogs before editing. The agent authoring guide shows the request model and revision handling.

Runtime

The runtime contract specifies the supported Node compatibility subset, Code capabilities, HTTP access, workflow calls, Artifacts, Flow State, and failure classification. It does not grant arbitrary npm package installation or access to host resources.

Authorization and events

The authorization references separate Connection use declarations, shared grants, execution snapshots, and provider-event permissions. Consult them when integrating a Connector backend or hosting event callbacks.

CLI and MCP

Command distribution and MCP references describe transport and setup. Both call the same deployment services as the Workbench. They do not provide independent persistence or execution authority.

Version compatibility

The compatibility contract records published model and Engine boundaries. Historical Revisions retain their identity. Upgrade deployments and consumers together when a new contract requires it.

Read these pages as Markdown

Every page exposes an index.md alternative with the article body, product version, sources, and example file links. The localized llms.txt index lists the available pages. Interactive controls are omitted; example inputs, expected results, and prerequisites remain readable.

Sources

Search