Skip to main content

Avoma

Avoma is an AI-powered meeting intelligence platform that automatically records, transcribes, and analyzes meetings to provide actionable insights. The Avoma connector enables you to access meeting data, transcriptions, notes, and user information from your Avoma account, allowing you to integrate meeting intelligence into your data workflows.

Avoma icon

Power end-to-end data operations for your Avoma API with Nexla. Our bi-directional Avoma connector is purpose-built for Avoma, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Avoma or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Avoma workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Avoma credential, you'll need to obtain an API key from your Avoma account. Only users with Admin privileges can create, delete, or retrieve API keys.

To obtain the required API key for Avoma:

  1. Sign in to Avoma: Navigate to your Avoma account and sign in. If you don't have an account, you can sign up at https://www.avoma.com/.

  2. Access Developer Settings: Once signed in, navigate to Settings in the left sidebar menu, then select Organization from the settings options. Within the Organization settings, click on the Developer tab. This section is only accessible to users with Admin privileges. If you don't see the Developer tab, you may need to request Admin access from your Avoma account administrator.

  3. Create API Key: In the Developer settings page, locate the API Keys section. Click the Create API Key button or Generate New Key button to create a new API key for your account. You may be prompted to enter a name or description for the API key to help you identify it later.

  4. Copy API Key: After creating the API key, it will be displayed on the screen. Important: Copy the entire API key value immediately and store it in a secure location. Avoma may not display the full key again after you navigate away from this page, so ensure you have saved it before closing the page. The API key is a long string of characters that serves as your authentication token for all API requests.

    The API key is sensitive information that should be kept secure. Store it in a secure location, as you'll need it when creating the credential in Nexla. Only users with Admin privileges can manage API keys in Avoma.

  5. Verify Permissions: Ensure your account has the necessary permissions to access the data you want to retrieve through the API. The API key inherits the permissions of the user account that created it. This means if your user account can access meetings, notes, and transcriptions in the Avoma UI, your API key will have the same level of access. If you need access to additional data, you may need to request permission changes from your Avoma administrator.

The Avoma API uses Bearer token authentication, where the API key is sent in the Authorization header as Bearer {API_KEY}. The base URL for API requests is https://api.avoma.com/v1. For complete information about Avoma API authentication and managing API keys, see the Avoma API Documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesYour Avoma API key.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Avoma

AvomaCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Enter your Avoma API key in the API Key field. This confidential key is used to securely authenticate your application during API requests. The API key is sent in the Authorization header as a Bearer token for all API requests.

    The API Key is sensitive information that should be kept secure. Nexla will store this credential securely and use it only for API authentication purposes. Ensure you have Admin privileges in your Avoma account to generate API keys.

  3. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Avoma connector tile, then select the credential that will be used to connect to the Avoma instance, and click Next; or, create a new Avoma credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Avoma endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Meetings

This endpoint retrieves a list of meetings from your Avoma account within a specified date range. Use this endpoint when you need to access meeting metadata, including meeting dates, participants, and associated information.

  • Enter the start date for data retrieval in the From Date field. Use the format YYYY-MM-DD (e.g., 2024-01-01). This date specifies the beginning of the date range for meetings you want to retrieve. You can also use Nexla macros like {now-30} for relative dates, which will automatically calculate the date 30 days before the current date. This is useful for creating recurring data sources that always fetch the last 30 days of meetings.
  • Enter the end date for data retrieval in the To Date field. Use the format YYYY-MM-DD (e.g., 2024-01-31). This date specifies the end of the date range. You can use macros like {now} for the current date to always fetch meetings up to today. The end date must be equal to or later than the start date.
  • The endpoint uses pagination to handle large datasets efficiently, automatically fetching additional pages as needed with a default page size of 100 records per request. If your date range contains more than 100 meetings, Nexla will automatically make additional API calls to retrieve all meetings in the specified range.

This endpoint supports pagination and will automatically retrieve all meetings within the specified date range. The date range should be configured based on your data freshness requirements and the volume of meetings in your account. For accounts with many meetings, consider using shorter date ranges (e.g., daily or weekly) to optimize performance and reduce API load. The endpoint returns meeting metadata including meeting IDs, titles, dates, participants, and associated recording information.

List Users

This endpoint retrieves a list of all users in your Avoma account. Use this endpoint when you need to access user information, including user names, email addresses, and account details.

  • This endpoint automatically retrieves all users accessible to your account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint returns user data including user IDs, names, email addresses, and other account information.

This endpoint returns all users in your organization. Use this endpoint to build user lookups or to retrieve user metadata for analysis purposes.

List Notes

This endpoint retrieves notes related to meetings in your Avoma account. Use this endpoint when you need to access meeting notes, action items, and other annotations created during or after meetings.

  • Enter the maximum number of notes to retrieve in the Limit field. The default value is 10, but you can adjust this based on your needs. Higher values will retrieve more notes per request, but be aware that very large limits may result in slower API responses. The limit parameter controls how many notes are returned in a single API call. If you need to retrieve all notes, you may need to use multiple requests or configure the data source to make multiple calls with different limit values.
  • The endpoint returns notes associated with meetings, including note content, creation dates, timestamps, note types (action items, key points, etc.), and related meeting information. Notes can include text content, tags, and metadata that help organize and categorize meeting information.

The limit parameter controls how many notes are retrieved in a single request. For large datasets, consider using multiple requests with different limits or date ranges to retrieve all notes.

List Transcriptions

This endpoint retrieves meeting transcriptions from your Avoma account within a specified date range. Use this endpoint when you need to access full meeting transcripts, including speaker identification and timestamps.

  • Enter the start date for transcription retrieval in the From Date field. Use the format YYYY-MM-DD (e.g., 2024-01-01). You can use macros like {now-30} for relative dates.
  • Enter the end date for transcription retrieval in the To Date field. Use the format YYYY-MM-DD (e.g., 2024-01-31). You can use macros like {now} for the current date.
  • The endpoint retrieves transcriptions for all meetings within the specified date range, including full transcript text, speaker information, and timestamps.

Transcriptions contain the full text of meeting recordings, including speaker identification and timestamps. This endpoint is useful for analyzing meeting content, extracting insights, performing sentiment analysis, or building searchable archives of meeting transcripts. The transcription data includes the spoken text, speaker names or identifiers, and timestamps for each segment, allowing you to track who said what and when during the meeting.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Avoma data sources can also be manually configured to ingest data from any valid Avoma API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Avoma API endpoints use the base URL https://api.avoma.com/v1, with the API key sent in the Authorization header as a Bearer token. For a complete list of available Avoma API endpoints, see the Avoma API Documentation.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Avoma data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.