Text To Speech
Last updated
Was this helpful?
Last updated
Was this helpful?
Text To Speech - User Guide
Description: Text To Speech is an AI-powered tool that converts text into spoken audio.
Usage Steps:
Text Input:
Enter the desired text into the "Text1" field.
Retrieve the Output:
Once the process is complete, access the audio output via the output state.
Detailed Setup:
Installing the Plugin:
In your application editor, navigate to the “Plugin” tab and open the “Add Plugins” section.
In the search box, type “Aicado AI Connector” and select the relevant plugin from the search results to complete the installation.
Once installed, the Aicado AI Connector plugin will be ready for use.
This setup enables your Text To Speech functionality, allowing you to convert written text into audio seamlessly using AI.
At this stage, two different tokens are required for the plugin to function correctly. The first token is the Aicado Access Token. You can obtain your Aicado Access Token by following these steps:
Log in to the Aicado AI website.
Navigate to the Profile or Settings section.
Copy the “Aicado Access Token” that appears.
After completing these steps, you can move on to acquiring the second token.
Then, paste the copied Aicado Access Token into the corresponding Access Token section within your application and save it. This step is necessary to authorize the plugin.
In the next step, you need to fill in the "your_api_token" field. Follow these instructions:
In your application editor, go to the Settings section.
Enter the API tab.
You will see an option or button labeled “Generate a new API Token.”
Click this button, then copy the generated API Token.
Finally, paste the copied value into the "your_api_token" field within the plugin.
This will complete all the required tokens for the plugin.
Then we add a button and create a workflow for this button.
Properties Area and Usage
This section contains the essential information required for the application to operate. You can select the "Text To Speech" AI model from the AI Model tab and enter the necessary data in the designated field:
text1 – for text input.
Webhook (Callback) Settings
To process responses from the AI model, you need to define a “webhook response.” This setup requires the root URL of the Workflow API. Follow these steps to obtain the URL:
Navigate to Settings > API.
On the API page, take the displayed root URL and append the event name you created previously in Backend Workflows.
For instance, if your event name is “get-response”, the resulting URL might look like:
With this configuration, the data from the AI model is transmitted via the defined webhook to your backend workflow, allowing your application to execute the necessary operations.
Open the Workflow: Open the workflow screen for the button you previously created.
Add Action: Click the “Click here to add an action” link and select the Aicado AI Connector action from the list.
AI Model: Choose the desired AI model (in this case, Text To Speech) from the dropdown list.
Response Webhook URL: Set the Response Webhook URL to the following format:
This URL points to the get-response workflow you have created in the backend.
Model Customization Fields: For Text To Speech, fill in the following field:
text1 – the text you want to convert to speech.
Save Workflow: After filling in all required fields, save the workflow.
Test in Preview Mode: Run your application in Preview mode, click the button, and confirm that the AI model’s response is processed into your database via the get-response backend workflow.
Once these steps are completed, your button will trigger the Text To Speech AI model, and the incoming response will be stored in the backend with the defined parameters.
Saving the Output and Adding Run ID
Follow these steps to store the response from the Text To Speech AI model and record the Run ID in your database:
In your button’s workflow, add the “Create a new thing” action.
In the Type field, select the AI Output data type.
In the run_id field, set the value to the Run ID returned from Step 1 (Aicado AI Connector). For example, use the expression:
Save the Workflow: After configuring the action, save the workflow.
Test the System: In your application, select the desired AI model (Text To Speech) and click the button. The AI model will execute, and the response will be stored in the AI Output record in your database with the corresponding run_id.
Once completed, your system will be fully set up: when you select your AI model and click the button, the process will automatically run, and the output will be saved along with the Run ID.
Defining “Data Types”
For your application to operate smoothly, you need to create the following fields in the Data Types section with exactly the names (in quotes) and types specified:
Data Types Definition:
expense — number
output — text
output_list — text (list)
run_id — text
Important Notes:
Write the field names exactly as shown above; do not add any uppercase/lowercase variations, spaces, or underscores.
Ensure that you select the correct types (Number or Text).
Mismatched names or types may cause errors during data recording by the backend workflows.
For the plugin to function, you need to define a "backend event." Follow these steps to complete this process:
Go to the Backend Workflows section.
Click the New API Workflow button to create a new API workflow.
This step is essential for the plugin to process the required data appropriately.
Creating a New Backend Workflow and Configuring Parameters
Workflow Name:
In the opened window, assign any name you wish to the workflow. For example, you can name it "get-response".
API Workflow Setting:
Check the “Expose as a public API workflow” option to make your workflow accessible as an API endpoint.
Creating Parameters:
Click the “Add a new parameter” button.
Configure the following parameters:
output (type: text)
output_list (type: list of text)
run_id (type: text)
expense (type: number)
For each parameter, activate the Optional checkbox and ensure that the object type remains as a JSON Object.
These parameters are critical for the system to function correctly, so please ensure that all are added accurately without omissions.
Creating a New Backend Workflow and Configuring Parameters
Workflow Name:
In the opened window, assign a name for the workflow. For example, you can use “get-response.”
API Workflow Settings:
Check the “Expose as a public API workflow” option. This setting makes your workflow accessible as an API endpoint.
Adding Parameters:
Click on the “Add a new parameter” button.
Configure the workflow with the following parameters:
output (text)
output_list (list of text)
run_id (text)
expense (number)
For each of these fields, ensure that the Optional checkbox is activated. Also, verify that the object type remains as JSON Object.
These parameters are critical for the correct operation of the system, so please make sure to add all of them without any omissions.
Now it's time to test your project using the button you created. For the Text To Speech model, please ensure that the text1 field is filled with the required value before testing.
