Skip to main content

Authorization

Follow this guide to create a new Avoma credential that will allow Nexla to authenticate to and exchange data with your Avoma account.
avoma_api_auth.png

Avoma

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.

Avoma Account Setup​

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.

  1. 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.

For complete information about Avoma API authentication and managing API keys, see the Avoma API Documentation.

API Access Requirements​

Avoma API access requires:

  • Valid Avoma Account: You must have an active Avoma account
  • Admin Privileges: Only users with Admin privileges can create and manage API keys
  • API Key: A valid API key generated from your Avoma account settings

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.

Create an Avoma Credential​

  • To create a new Avoma credential, 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

Credential Name & Description​

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

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication Configuration​

  1. API Key: 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.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.