Skip to main content

OpenAPI description

About OpenAPI descriptions​

OpenAPI is a standard specification for describing REST APIs. OpenAPI descriptions allow both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation. ChatKitty has made its RESTful Platform API publicly available as an OpenAPI 3.0 compliant document.

Getting the ChatKitty OpenAPI description​

You can find the open source Platform API REST description here.

Using the ChatKitty OpenAPI description​

There are many uses for an OpenAPI description. For example, you could:

  • Generate your own API client.
  • Validate and test a ChatKitty Platform API integration.
  • Explore and interact with the ChatKitty Platform API using third-party tools, such as Insomnia or Postman.

For example, ChatKitty uses the REST OpenAPI description to generate the ChatKitty Platform API reference documentation.