App runtime OpenAPI

The OpenCloud app runtime specification is a machine-readable OpenAPI 3.1 reference for coding agents building deployed applications.

It covers the same-origin runtime surfaces:

• runtime discovery and the deployment-pinned JavaScript SDK;
• safe session brokering;
• app-schema database access through PostgREST;
• app-scoped object Storage;
• app-defined Functions;
• safe runtime telemetry; and
• Realtime WebSocket connection metadata.

The specification intentionally does not mix in the OpenCloud control plane. App creation, source drafts, deployments, verification, secrets, backups, and telemetry are covered by the separate control plane OpenAPI.

Use it

Give an agent the stable public URL:

https://docs.opencloud.ai/openapi.yaml

Or download the source from this repository:

docs/openapi/app-runtime.yaml

The OpenAPI file describes HTTP boundaries. Browser code should still use the deployment-pinned @opencloud/js module returned by GET /_opencloud/config. The SDK owns bearer tokens, cookies, app identity headers, and refresh behavior.

Database records and Function request/response bodies are app-defined, so those portions of the schema are intentionally open-ended. Realtime messaging uses a WebSocket protocol; the file provides connection metadata through an x-opencloud-realtime extension while the JavaScript SDK owns channel behavior.