Skip to main content

OpenAPI specification

The whole /v1 API is described in a single OpenAPI 3.0 file: every endpoint, field, response, error code and the webhook payload.

Download v1.yaml

Use it with​

  • Postman — Import → choose v1.yaml. You get a collection with every request. Set the bearerToken to your test key.
  • Insomnia — Import → From file.
  • Code generators — e.g. openapi-generator-cli generate -i v1.yaml -g python -o cloudmetis-client (also php, typescript-fetch, java, …).

Always accurate​

This file is checked against the real API on every backend change: automated tests send real requests and fail if any response doesn't match it. When the API changes, the file and these docs change with it — see the changelog.