OpenAPI Reference

OpenAPI is the machine-readable contract of the Control Plane API. It is convenient for checking request and response schemas, generating clients, and importing collections into tools such as Postman or Insomnia.

When OpenAPI is useful

OpenAPI is especially helpful in three cases:

• you are writing your own integration and want to validate payloads in advance;
• you are generating types or an SDK for an internal service;
• you are building a test collection of requests and do not want to copy schemas manually.

What is important to remember

• the user API is under the /v2 prefix;
• authorization uses Authorization: Bearer <api-key>;
• the PostgreSQL DSN and tenant credentials in OpenAPI do not replace a regular connection through Gateway;
• the presence of an interactive reference page depends on the specific delivery environment.

How to use the specification in practice

1. Obtain the published OpenAPI specification for your environment.
2. Import it into Postman, Insomnia, or your client generator.
3. Verify that the base URL points to your Control Plane.
4. Add Bearer authorization and an environment with CP_URL.
5. Keep the curl examples from the documentation nearby for day-to-day work — they are easier to debug manually.

If the interactive reference is unavailable

That does not block day-to-day work. For most users, the following are enough:

• the API route descriptions in the API section;
• ready-to-use curl examples;
• Console for manual operations;
• CLI for terminal-based workflows.

Here, OpenAPI is more of a precise integration tool than a mandatory daily entry point.