API Assistant is a feature of Globant Enterprise AI that allows you to define assistants to chat and interact with any external REST API compliant with the OpenAPI 3.0 specification or higher.
This assistant leverages AI models and function calling capabilities to provide a dynamic way to chat with APIs using natural language.
Defining an API Assistant provides a range of advanced features designed to empower interaction with external APIs in an efficient and secure manner.
Key features include:
- Compatibility with OpenAPI 3.0: It is possible to interact with any API that is built following the OpenAPI 3.0 specification or later.
- Customizable instructions:The user can provide specific text instructions to guide the AI assistant in making decisions and accurately handling requests.
- Model settings: It allows you to adjust the AI model settings, such as temperature and the maximum number of tokens generated, to enhance and customize the assistant's answers according to the user's needs.
- Security: It ensures the security of interactions through the use of API tokens. These tokens, which can be of Basic or Bearer type, are used in the Authorization header to authenticate and authorize requests, thus protecting information and data.
- Automated function calls: It returns answers efficiently by making only the necessary API calls. This is achieved by Globant Enterprise AI's intelligent model and automated function calls handling end user requests.
- Multiple API calls: The assistant’s intelligence is shown by making sequential calls to different APIs to obtain complex results. For example, upon receiving a question such as 'What is the weather like in Tokyo and Montevideo?' the assistant identifies the need to query the weather API for each city mentioned. This ability to automatically handle multiple requests ensures a seamless experience for the user, who doesn't need to intervene in the process.
Before starting to use API Assistant, it is important to ensure that certain prerequisites are met:
- You need to access Globant Enterprise AI. To do so, you can visit the official website, where you will find contact information and details on how to obtain access to the platform.
- If your API is authenticated with an API Token (either Basic or Bearer), you must configure your requests to include this token in the authorization header, specifying the correct type. For example:
-H "Authorization: Bearer $OPENAI_API_KEY". In this way, when executing the call, the token will be used for the interaction.
- Verify that the API Specification is documented according to OpenAPI 3.0 or higher, in JSON format. This is important, as APIs that do not comply with this specification may not be fully supported.
- Avoid setting Message streaming because it is not supported.
To define or update an API Assistant, you can use the Globant Enterprise AI Backoffice by following the steps described in How to use API Assistant or using the API.