Skip to content

OpenAPI Specification

The Contio MeetingOS User API is fully documented with an OpenAPI (Swagger 2.0) specification. The spec is generated directly from the /v1 controller annotations — it is never hand-edited — and is regenerated on every release, so it always matches the deployed API.

Browse Interactive API Reference

Download Specifications

Quick Start with Postman

Import the Postman collection to test the API interactively. The collection includes scripted OAuth 2.1 + PKCE authentication steps — no code required. See the Postman Collection Guide for detailed instructions.

Using the OpenAPI Spec

Generate client code

Use the spec to generate client libraries in any language:

# Using OpenAPI Generator
openapi-generator generate \
  -i user-openapi.json \
  -g typescript-axios \
  -o ./generated-client

# Using Swagger Codegen
swagger-codegen generate \
  -i user-openapi.json \
  -l python \
  -o ./python-client

View in Swagger Editor

  1. Go to Swagger Editor
  2. File → Import File → select user-openapi.yaml
  3. Explore the API interactively

Specification Overview

Authentication scheme

The spec defines a single security scheme, ContioAuth:

  • Type: API key sent as Authorization: Bearer <token>
  • Resource endpoints accept a personal access token (cto_pat_v1_), an OAuth access token (cto_at_v1_), or a workspace API key (cto_wk_v1_)
  • OAuth authorize/revoke endpoints instead require an authenticated user session

See the Authentication guide, Personal Access Tokens, and Workspace API Keys for details.

Keeping up to date

The specification carries a version in its info block:

info:
  title: Contio MeetingOS User API
  version: "1.1.0"

Because the spec is generated from the controllers, a CI drift check (task api:openapi:check) fails the build if the committed spec ever falls out of sync with the code.

Support

Issues with the OpenAPI spec?

  • Report issues to support@contio.ai
  • Include the spec version and a description of the issue