Skip to main content

OpenAPI reference

The machine-readable contract behind the versioned change-engine API. Expand an endpoint to inspect its parameters, JSON body, responses and schemas.

Using the reference

Filter by endpoint group, expand a method, or follow a schema reference. Operation links can be bookmarked. Download OpenAPI YAML to import into Swagger Editor, Postman or your own tooling.

Read-only explorer. Request execution and credential entry are disabled. No token is needed to browse. To call the API from your own client, first follow authentication and scopes.

This contract covers /api/v1, not all internal dashboard or legacy APIs. The two auth-exchange modes share one method/path and are selected using the op query parameter. Planning and HTTP 202 do not prove provider execution or consumer acceptance.

Endpoints and schemas

Loading endpoint explorer… You can also download the OpenAPI file above.

c3209c7