Connect to AssemblyAI
You can connect to AssemblyAI using Retool's REST API integration and make it available as a resource. Once complete, you can write queries to interact with the AssemblyAI API.
Requirements
All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.
To create your AssemblyAI resource, you'll need:
1. Create a new resource
Sign in to your Retool organization and navigate to the Resources tab. Click Create new, then select Resource.
Retool can connect to almost any API or database, and has built-in integrations for popular data sources. For AssemblyAI, you'll use the REST API integration.
2. Configure the resource
Provide the necessary details to configure the resource so Retool can connect to AssemblyAI. Not all settings are required but refer to the AssemblyAI documentation to learn what is needed.
General
These settings configure the name and location of the resource within Retool.
Name
The name to use for the resource (e.g., AssemblyAI).
Folder
The folder in which to save the resource.
Description
A brief description of the resource (e.g., Customer data).
Credentials
These settings configure how Retool connects to AssemblyAI.
Base URL
The base URL for the AssemblyAI API. This must be an absolute URL. Use https://api.assemblyai.com/v2.
URL parameters
Key-value pairs to include as URL parameters with AssemblyAI API requests. No additional URL parameters are required.
Headers
Key-value pairs to include as headers with AssemblyAI API requests. Include the following key-value pairs:
| Key | Value |
|---|---|
Authorization | YOUR_ASSEMBLY_AI_API_KEY |
Content-Type | application/json |
Body
Key-value pairs to include in the body of AssemblyAI API requests. No additional body values are required.
Cookies
Cookies to include with AssemblyAI API requests. No cookies are required.
Authentication
The method of authentication to use with AssemblyAI. This is not required, as your authentication credential is set in the Authorization header you configured above.
Forward all cookies
Whether to forward all cookies. This is useful if you have dynamic cookie names.
3. Save the resource
Click Create resource to complete the setup. You can then click either Create an app to immediately start building a Retool app or Back to resources to return to the list of resources.
Wrap up
Your AssemblyAI resource is now ready to use. You write queries to make API requests by specifying the request method and endpoint, additional parameters to include, and the request body.
To verify you can successfully interact with AssemblyAI, write a test query to retrieve some data. The following example request fetches a transcript with a given identifier as a URL path parameter.
- Request
- Response
GET https://api.assemblyai.com/v2/transcript/6rlr37h8f4-e310-4e23-bbf3-ea5f347dc684
{
"id": "6rlr37h8f4-e310-4e23-bbf3-ea5f347dc684",
"language_model": "assemblyai_default",
"acoustic_model": "assemblyai_default",
"language_code": "en_us",
"status": "completed",
"audio_url": "https://cdn.assemblyai.com/upload/83bdd119-9099-46c9-8845-50c3ec763fce",
"text": "<some text here>"
"words": [
{
text:"<some word>",
start: 570,
end: 1120,
confidence: 0.38123,
speaker: null
},
{
"text": "<some word>",
"start": 5170,
"end": 5786,
"confidence": 0.75417,
"speaker": null
}
],
"utterances": null,
"confidence": 0.9112455882352947,
"audio_duration": 200,
"punctuate": true
}