Learn how to use the Tess AI API in an enhanced way!
Integrating the Tess AI API into Your Workflows
This article explains how to use the Tess AI API to integrate artificial intelligence into your external workflows, automating tasks and enriching data.
API Principles
The API allows external applications to access Tess AI functionalities, such as agent execution, natural language processing, and other AI tasks. This enables the integration of AI into your own systems, leveraging the training and prompts configured on the Tess AI platform.
Example Use Case (Transcription and Minute Generation)
A school administrator can automate the generation of meeting minutes. They record the meeting, save the video to Google Drive, and the Tess AI API is triggered. The audio is transcribed using services like Deepgram, AssemblyAI, Have.ai, or OpenAI's Whisper. The transcription is then processed by an agent in Tess AI, trained to generate formatted minutes.
API News
Tess AI is constantly evolving, and new features are added regularly. Stay tuned for updates in the API documentation.
Accessing the API
There are two main ways to access the API:
- AI Studio (Automations): Create automations that trigger webhooks for your agents/templates.
- API Tokens: Generate an access token in the "API Tokens" section of your profile and use it to authenticate your requests. The complete API documentation is available in the top menu of the platform.
Practical Case: Feedback Classification
Automation to classify customer feedback (sentiment, category, reason) based on new entries in a spreadsheet.
Integration with Zapier (step by step)
- Authentication: Authenticate on Zapier with your Tess AI API token.
- New Zap: Create a new Zap.
- Trigger: Choose the "New Spreadsheet Row" trigger (Google Sheets).
- Select Spreadsheet: Select the spreadsheet and the sheet containing the feedback.
- Action: Execute Template: Add the "Execute Template" action (Tess AI App).
- Select Template: Choose the feedback classification template.
- Map Fields: Map the "feedback" and "stars" fields from the spreadsheet to the corresponding template parameters.
- Webhook Callback URL (for the second Zap): Configure the "Webhook Callback URL" for a second Zap that will process the response.
- Second Zap - Trigger: Create a second Zap with the "Catch Hook" trigger.
- Copy Webhook URL: Copy the webhook URL generated in the second Zap and paste it into the "Webhook Callback URL" field of the first Zap.
- Second Zap - Map Fields: In the second Zap, map the fields from the Tess AI response ("sentiment," "category," "reason") to the corresponding columns in the spreadsheet.
- Second Zap - Action: Update Row: Add the "Update Spreadsheet Row" action (Google Sheets).
- Map Row ID: Map the row ID to ensure the correct record is updated.
- Alternative (Delay): As an alternative to the second Zap, use the "Delay" action in the first Zap to wait for the Tess AI response. This simplifies the flow but may be less efficient for time-consuming processing.
Integration with Make (step by step)
- New Scenario: Create a new scenario in Make.
- Trigger: Add the "Watch Spreadsheet Changes" trigger (Google Sheets).
- Select Spreadsheet: Select the spreadsheet and the sheet containing the feedback.
- HTTP Module (POST): Add the "HTTP" module and set the method to POST.
- Execution URL: Configure the template execution URL (see the Tess AI API documentation).
- Authorization Header: Add the "Authorization" header with the value "Bearer <your_token>".
- Request Body: In the request body, provide the parameters ("feedback", "stars") in JSON or "multipart/form-data" format.
- Store Execution ID: Add a "Set Variable" module to store the execution ID returned by the API.
- Repeater Module (Polling): Add a "Repeater" module to implement polling.
- Polling Interval: Configure the time interval between status checks.
- HTTP Module (GET) inside the Repeater: Inside the repeater, add an "HTTP" module with the GET method.
- Status Check URL: Configure the status check URL (from the API documentation), including the previously stored execution ID.
- Authorization Header (GET): Add the "Authorization" header with the value "Bearer <your_token>".
- Repeater Stop Condition: Configure the repeater to stop when the "status" field of the response is "success" or "fail".
- Extract Data from Response: After the repeater, add a "Set Variable" module to extract the data from the response ("sentiment", "category", "reason").
- Update Spreadsheet: Add the "Update a Row" module (Google Sheets).
- Map Data to Spreadsheet: Map the variables containing the extracted data to the corresponding columns in the spreadsheet.
- API Credits: Using the API consumes credits, even with the platform's unlimited plan. Consumption is reported in automation responses.
Discover all this in Tess AI!