Welcome to the KINOVA® KORTEX™ API documentation. If you are a newcomer, feel free to check our installation procedure. Once this is done, a good starting point would be the getting started section. It includes the API mechanism, the error management and some code examples.

This API uses Google Protocol Buffer message objects1 to exchange data between client and server.

Google Protocol Buffer offers structured data objects with standard methods for each member field:

  • structured, nested objects

  • basic types and collections

  • getter/setter methods on basic types

  • iterators, dimension and appending methods on collections

  • many helpers (e.g. serialize/deserialize, I/O functions)

When using the Kortex API a developer will need to understand the Google Protocol Buffer feature set to maximize their efficiency.