Skip to content
Docs/API reference

OpenAPI download

Download the customer API contract to inspect request models, generate a client, or compare changes before updating an integration.

On this pageUse the contractWhat the schema can tell youKeep clients compatible

Download OpenAPI JSON

Use the contract

  1. Download the JSON and import it into a tool that supports OpenAPI 3.1.
  2. Set the server/base URL to the exact API URL provided for your deployment. Preserve any base path, such as /app.
  3. Configure Bearer authentication using a supported credential. Follow authentication and permissions before sending write requests.
  4. Use the endpoint directory to find the resource guide and field reference for an operation.

The published file is generated from application routes and models with an explicitly reviewed customer scope. It excludes platform-operator administration, provider-operated callbacks, internal presentation endpoints, and placeholder payment operations. It does not change the live service's routes.

What the schema can tell you

The contract includes declared paths, HTTP methods, query/path parameters, typed bodies, responses, model requirements, defaults, and validation bounds. Authentication is annotated for customer endpoints; the inbound sensor URL carries its own secret token.

Some handlers accept a generic object and perform validation at runtime. In those cases the linked resource guide is necessary: an unconstrained-looking object in OpenAPI does not mean arbitrary fields will work. Likewise, declared success responses do not enumerate every runtime error, feature-availability check, permission, or streaming event.

Use the resource guides for examples and the error reference for actual error handling. For AI Studio, also read its streaming and payload guide.

Keep clients compatible

Preserve opaque IDs, upload handles, and cursor tokens exactly. Ignore response fields your client does not need, and handle unknown future run states conservatively. Do not retry an uncertain write automatically unless your application can tolerate duplicate execution.

The live service may also expose /openapi.json relative to its base URL; that schema can include platform-only routes and implementation docstrings. The downloaded customer contract is the reference for this developer documentation. Compare against your deployed API when diagnosing a version mismatch.