Skip to main content

APIs

In this section, you will find documentation related to the available Teneo Application Programming Interfaces (APIs). Below is included links to reference articles and to relevant APIs, Javadocs, etc.

Within a solution​

From within a solution a few different APIs can be referenced - these are called from within groovy scripts.

Engine Scripting API​

Engine Scripting API describes the methods available to interact with the Engine executing the solution at runtime. This provides access to dialogue state, input and output data as well as some helper methods for manipulating text.

The key entry points into the scripting are:

  • engineAccess (alias: _) which provides access to the state and functionalities of the Teneo Engine including dialog history and Input Annotations.
  • engineEnvironment which provides access to the state of the servlet session including Request Parameters and Cookies.

Date & Time Handler​

Date & Time Handler API describes the methods available for post-processing of Date & Time data to interpret dates and times given in the input.

The key entry point for the interpretation is the Handler class, specifically the interpret methods which are used in a solution to interpret the given inputs (more here).

Published Solutions​

Applications can use the Teneo API to send and receive messages from a Published solution. This reference article describes how to use the Teneo API JSPs via HTTP(s); read more.

Component APIs​

It is possible via the Teneo Components APIs to integrate Teneo components into external system via scripts or CI/CD pipelines etc.

Versioning

The Inquire and Studio APIs are versioned.
API Versioning provides the ability to migrate usage of the API to the current version without breaking changes. The previous versions will be available until the next release to support seamless upgrades of critical systems.

Teneo Studio API​

  • Logins, Sessions and Authentication describes the different types of login and sessions that Studio supports and how these can be used.
  • API reference has a complete description of all endpoints their relevant data schemas.
  • Studio Web Sockets API describes the endpoints (and their usage) when interacting with Teneo Studio via web sockets for solution change notifications.

Teneo Inquire API​

Inquire API describes the API endpoints that can be used to perform queries and manage log data. This reference article is aimed at developers who want to connect their services with the Inquire API