---
canonical_url: "https://docs.composio.dev/toolkits/avoma"
markdown_url: "https://docs.composio.dev/toolkits/avoma.md"
product: "platform"
version: null
last_updated: null
---

# Avoma

Avoma is an AI meeting assistant for recording, transcribing, analyzing, and managing meetings, calls, notes, scorecards, and conversation intelligence.

- **Category:** ai meeting assistants
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 16
- **Triggers:** 0
- **Slug:** `AVOMA`
- **Version:** 00000000_00

## Tools

### Create Call

**Slug:** `AVOMA_CREATE_CALL`

Submit an externally hosted call recording to Avoma for asynchronous processing. This persistently creates external call state, and Avoma will download the recording from the supplied publicly reachable URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_at` | string | No | Call end time in ISO 8601 UTC format. |
| `source` | string | Yes | Lowercase source system, such as twilio, zoomphone, ringcentral, or aircall. |
| `to_name` | string | No | Name of the called person. |
| `answered` | boolean | No | Whether the call was answered. |
| `start_at` | string | Yes | Call start time in ISO 8601 UTC format. |
| `direction` | string ("inbound" | "outbound") | Yes | Call direction. |
| `from_name` | string | No | Name of the caller. |
| `to_number` | string | Yes | Destination phone number. |
| `user_email` | string | Yes | Email of the licensed Avoma user who made or received the call. |
| `external_id` | string | Yes | Unique ID from the source dialer. Use a stable identity and never reuse it for a different call. |
| `from_number` | string | Yes | Originating phone number. |
| `is_voicemail` | boolean | No | Whether the recording is a voicemail. |
| `participants` | array | Yes | Call participants, with the prospect or lead first. Every participant requires an email address. |
| `recording_url` | string | Yes | Publicly reachable recording URL that Avoma can download for processing. |
| `crm_associations` | array | No | CRM objects associated with the call. |
| `additional_details` | object | No | Provider-specific JSON metadata to store with the call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Call

**Slug:** `AVOMA_GET_CALL`

Retrieve one externally ingested Avoma call by the dialer system's external ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | Unique call ID supplied by the source dialer when the call was ingested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Summary

**Slug:** `AVOMA_GET_ENGAGEMENT_SUMMARY`

Aggregate Avoma engagement metrics across visible users for a required UTC date range and optional meeting and user filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `is_call` | boolean | No | True for voice calls, false for video meetings, or omit for both. |
| `to_date` | string | Yes | Inclusive meeting end time in ISO 8601 UTC format. |
| `from_date` | string | Yes | Inclusive meeting start time in ISO 8601 UTC format. |
| `is_internal` | boolean | No | True for internal meetings, false for meetings with external attendees, or omit for both. |
| `user_emails` | array | No | User email addresses to include. |
| `is_impromptu` | boolean | No | Filter by unscheduled or ad-hoc meetings. |
| `meeting_type_uuids` | array | No | Meeting type UUIDs to include. |
| `shared_meetings_only` | boolean | No | Only include shared meetings when true. |
| `meeting_outcome_uuids` | array | No | Meeting outcome UUIDs to include. |
| `recording_duration_gte` | number | No | Minimum recording duration in seconds. |
| `recording_duration_lte` | number | No | Maximum recording duration in seconds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Meeting

**Slug:** `AVOMA_GET_MEETING`

Retrieve one meeting by UUID, including processing/readiness state and optionally CRM associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meeting_uuid` | string | Yes | UUID of the meeting to retrieve. |
| `include_crm_associations` | boolean | No | Include CRM associations in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Meeting Analysis

**Slug:** `AVOMA_GET_MEETING_ANALYSIS`

Return Avoma's AI insights, topical and speaker segments, and sentiment records for one processed meeting in a single read-only invocation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meeting_uuid` | string | Yes | UUID of a processed meeting whose analysis should be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Recording

**Slug:** `AVOMA_GET_RECORDING`

Get time-limited audio and video URLs for a meeting recording.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meeting_uuid` | string | Yes | UUID of the meeting whose recording links should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Calls

**Slug:** `AVOMA_LIST_CALLS`

List externally ingested calls in a required UTC date range, optionally filtered by inbound or outbound direction. Returns one page and a cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | Yes | Inclusive call end time in ISO 8601 UTC format. |
| `direction` | string ("inbound" | "outbound") | No | Only return inbound or outbound calls. |
| `from_date` | string | Yes | Inclusive call start time in ISO 8601 UTC format. |
| `next_cursor` | string | No | Opaque continuation cursor from a prior call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Configuration Resources

**Slug:** `AVOMA_LIST_CONFIGURATION_RESOURCES`

List one Avoma configuration catalog: custom categories, smart categories, scorecards, templates, meeting types, or meeting outcomes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string ("modified" | "-modified" | "name" | "-name" | "background_color" | "-background_color") | No | Optional ordering for custom_category or smart_category. Ignored for the other resource types. |
| `page_size` | integer | No | Items per page for meeting_type or meeting_outcome (1-100). Ignored for catalogs that Avoma returns as complete arrays. |
| `next_cursor` | string | No | Continuation cursor returned by a prior meeting_type or meeting_outcome call; omit for the first page. |
| `resource_type` | string ("custom_category" | "smart_category" | "scorecard" | "template" | "meeting_type" | "meeting_outcome") | Yes | Configuration catalog to list: custom_category, smart_category, scorecard, template, meeting_type, or meeting_outcome. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Engagement Metrics

**Slug:** `AVOMA_LIST_ENGAGEMENT_METRICS`

List per-user Avoma engagement metrics over a required UTC date range with meeting and user filters. Returns one page and an opaque cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string ("user_email" | "-user_email" | "conversations_listened" | "-conversations_listened" | "snippets_listened" | "-snippets_listened" | "conversations_shared" | "-conversations_shared" | "conversations_commented" | "-conversations_commented" | "total_comments" | "-total_comments" | "conversations_listened_duration" | "-conversations_listened_duration" | "conversations_listened_percent" | "-conversations_listened_percent") | No | Metric field to order by; a leading '-' selects descending order. |
| `is_call` | boolean | No | True for voice calls, false for video meetings, or omit for both. |
| `to_date` | string | Yes | Inclusive ISO 8601 UTC end time. |
| `from_date` | string | Yes | Inclusive ISO 8601 UTC start time. |
| `page_size` | integer | No | Users to return on this page (1-100). |
| `is_internal` | boolean | No | True for internal meetings, false for meetings with external attendees, or omit for both. |
| `next_cursor` | string | No | Opaque continuation cursor from a prior call; omit for the first page. |
| `user_emails` | array | No | Email addresses of users whose engagement metrics should be included. |
| `is_impromptu` | boolean | No | Filter by unscheduled or ad-hoc meetings. |
| `meeting_type_uuids` | array | No | Meeting type UUIDs to include. |
| `shared_meetings_only` | boolean | No | Only include shared meetings when true. |
| `meeting_outcome_uuids` | array | No | Meeting outcome UUIDs to include. |
| `recording_duration_gte` | number | No | Minimum recording duration in seconds. |
| `recording_duration_lte` | number | No | Maximum recording duration in seconds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Meetings

**Slug:** `AVOMA_LIST_MEETINGS`

Find meetings visible to the connected Avoma user within a required UTC date range, with optional attendee, CRM, call-type, privacy-context, duration, and ordering filters. Returns one page and an opaque cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string ("start_at" | "-start_at") | No | Sort by meeting start time; prefix with '-' for descending. |
| `is_call` | boolean | No | True for voice calls, false for video meetings, or omit for both. |
| `to_date` | string | Yes | Inclusive meeting end time in ISO 8601 UTC format. |
| `from_date` | string | Yes | Inclusive meeting start time in ISO 8601 UTC format. |
| `page_size` | integer | No | Meetings to return on this page (1-100). |
| `is_internal` | boolean | No | True for internal-only meetings, false for meetings with external attendees, or omit for both. |
| `next_cursor` | string | No | Opaque continuation cursor from a prior call; omit for the first page. |
| `crm_lead_ids` | array | No | CRM lead external IDs; any match is accepted. |
| `attendee_emails` | array | No | Return meetings containing any of these attendee email addresses. |
| `crm_account_ids` | array | No | CRM account external IDs; any match is accepted. |
| `crm_contact_ids` | array | No | CRM contact external IDs; any match is accepted. |
| `crm_opportunity_ids` | array | No | CRM opportunity external IDs; any match is accepted. |
| `recording_duration_gte` | number | No | Minimum recording duration in seconds; excludes meetings without recordings. |
| `include_crm_associations` | boolean | No | Include CRM associations on returned meetings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notes

**Slug:** `AVOMA_LIST_NOTES`

Retrieve Avoma notes for meetings in a required UTC date range, optionally narrowed to a meeting or custom category and rendered as JSON, HTML, or Markdown.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string ("modified" | "-modified") | No | Optionally order by modification time; a leading '-' means descending. |
| `to_date` | string | Yes | Inclusive meeting end time in ISO 8601 UTC format. |
| `from_date` | string | Yes | Inclusive meeting start time in ISO 8601 UTC format. |
| `page_size` | integer | No | Notes to return on this page (1-20). |
| `next_cursor` | string | No | Avoma continuation URL returned by a prior call; pass it back unchanged and omit it for the first page. |
| `meeting_uuid` | string | No | Only return notes for this meeting UUID. |
| `output_format` | string ("json" | "html" | "markdown") | No | Format for note content: json, html, or markdown. |
| `custom_category_uuid` | string | No | Only return note content belonging to this custom category UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Scorecard Evaluations

**Slug:** `AVOMA_LIST_SCORECARD_EVALUATIONS`

List Avoma scorecard evaluations, optionally filtered by UTC date range, scorecard templates, meeting, or evaluated users. Returns one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | Inclusive ISO 8601 UTC end time. |
| `from_date` | string | No | Inclusive ISO 8601 UTC start time. |
| `page_size` | integer | No | Evaluations to return on this page (1-100). |
| `next_cursor` | string | No | Opaque continuation cursor from a prior call; omit for the first page. |
| `user_emails` | array | No | Only return evaluations for these user email addresses. |
| `meeting_uuid` | string | No | Only return evaluations for this meeting UUID. |
| `scorecard_uuids` | array | No | Scorecard template UUIDs to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Snippets

**Slug:** `AVOMA_LIST_SNIPPETS`

Find user-created or AI-generated meeting snippets by meeting UUID or by a UTC date range of at most 180 days. Returns one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | Inclusive ISO 8601 UTC end time; required with from_date when meeting_uuid is omitted. The range cannot exceed 180 days. |
| `from_date` | string | No | Inclusive ISO 8601 UTC start time; required with to_date when meeting_uuid is omitted. |
| `page_size` | integer | No | Snippets to return on this page (1-100). |
| `next_cursor` | string | No | Continuation cursor from a prior call; omit for the first page. |
| `meeting_uuid` | string | No | Meeting UUID to filter by; otherwise both dates are required. |
| `is_ai_generated` | boolean | No | True for AI-generated snippets, false for user-created snippets, or omit for both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Transcriptions

**Slug:** `AVOMA_LIST_TRANSCRIPTIONS`

Find full meeting transcriptions by meeting UUID or by a UTC date range, with attendee and CRM filters. Returns one page because transcript payloads can be large.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | Inclusive ISO 8601 UTC end time; required with from_date when meeting_uuid is omitted. |
| `from_date` | string | No | Inclusive ISO 8601 UTC start time; required with to_date when meeting_uuid is omitted. |
| `page_size` | integer | No | Transcriptions to return on this page (1-100). |
| `next_cursor` | string | No | Opaque continuation cursor from a prior date-range call; omit for the first page. |
| `crm_lead_ids` | array | No | Filter by CRM lead external IDs. |
| `meeting_uuid` | string | No | Meeting UUID to fetch directly; when omitted, from_date and to_date are required. |
| `attendee_emails` | array | No | Return transcripts from meetings containing any listed attendee email address. |
| `crm_account_ids` | array | No | Filter by CRM account external IDs. |
| `crm_contact_ids` | array | No | Filter by CRM contact external IDs. |
| `crm_opportunity_ids` | array | No | Filter by CRM opportunity external IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `AVOMA_LIST_USERS`

Return users visible in the Avoma organization, including their UUID, email, role, teams, and active status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `AVOMA_LIST_WEBHOOKS`

Audit the connected organization's active Avoma webhook subscriptions without reading signing secrets.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |