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 Client APIs, Javadocs, clients, etc.
Applications can use the Teneo API to send and receive messages from the Teneo Engine. This reference article describes how to use the Teneo API JSPs via HTTP(s); read more.
Engine Scripting Javadoc
Engine Scripting API describes the methods available via groovy scripting in scripts within a solution.
The key entry points into the scripting are
_) which provides access to the state and functionalities of the Teneo Engine including dialog history and Input Annotations, and
engineEnvironment which provides access to the state of the servlet session including Request Parameters and Cookies.
Teneo Inquire exposes a public Rest API 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; read more.
Inquire Client API
Inquire Client API describes the methods provided for interacting with the Teneo Inquire API for querying session logs and other functions from within java code.
The key entry point for querying log data in Inquire is the
Inquire Server REST API Endpoints - Swagger
Inquire REST API describes the endpoints which can be called in order to interact with Teneo Inquire for querying session logs and other functions.
Inquire client and dependencies
swagger/teneo-inquire/client/index.html provides the jar files and dependency list for the Inquire client.
Manager Client Javadoc
The Manager Client describes the methods provided for interacting with the Teneo Manager API.
The key entry point is the
Manager Server REST API Endpoints - Swagger
Manager REST API describes the endpoints which can be called in order to interact with Teneo Manager for managing Teneo Platform user permissions and configuration.
Manager client and dependencies
swagger/teneo-manager/client/index.html provides the jar files and dependency list for the manager client.
The Logins, Sessions and Authentication page describes the different types of login and sessions that Studio supports and how these can be used.
Studio Client Javadoc
The Studio Client describes the methods provided for interacting with the Teneo Studio API.
The key entry point is the
Studio Server REST API Endpoints - Swagger
Studio REST API describes the endpoints which can be called in order to interact with Teneo Studio for editing, testing and publishing Teneo solutions.
Studio Server Web Socket API Endpoints
The Studio Web Sockets API page describes the endpoints (and their usage) when interaction with Teneo Studio via web sockets.
Studio client and dependencies
swagger/teneo-studio/client/index.html provides the jar files and dependency list for the Studio client.
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).
Splitting of user input text into sentences and words, spelling corrections as well as other solution language dependent processing is handled by the Input Processors and the Simplifier in the Teneo Platform; these are pluggable into Teneo Engine via the Input Processor API and allows users to create further language specific input processors; read more.