Skip to main content
Avoma logo
  • Category: ai meeting assistants
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: AVOMA
  • Version: 20261101_00

Tools

Slug: AVOMA_CREATE_CALLSubmit 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_GET_CALLRetrieve one externally ingested Avoma call by the dialer system’s external ID.

Input Parameters

string
required
Unique call ID supplied by the source dialer when the call was ingested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_GET_ENGAGEMENT_SUMMARYAggregate Avoma engagement metrics across visible users for a required UTC date range and optional meeting and user filters.

Input Parameters

boolean
True for voice calls, false for video meetings, or omit for both.
string
required
Inclusive meeting end time in ISO 8601 UTC format.
string
required
Inclusive meeting start time in ISO 8601 UTC format.
boolean
True for internal meetings, false for meetings with external attendees, or omit for both.
array
User email addresses to include.
boolean
Filter by unscheduled or ad-hoc meetings.
array
Meeting type UUIDs to include.
boolean
Only include shared meetings when true.
array
Meeting outcome UUIDs to include.
number
Minimum recording duration in seconds.
number
Maximum recording duration in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_GET_MEETINGRetrieve one meeting by UUID, including processing/readiness state and optionally CRM associations.

Input Parameters

string
required
UUID of the meeting to retrieve.
boolean
Include CRM associations in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_GET_MEETING_ANALYSISReturn Avoma’s AI insights, topical and speaker segments, and sentiment records for one processed meeting in a single read-only invocation.

Input Parameters

string
required
UUID of a processed meeting whose analysis should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_GET_RECORDINGGet time-limited audio and video URLs for a meeting recording.

Input Parameters

string
required
UUID of the meeting whose recording links should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_CALLSList externally ingested calls in a required UTC date range, optionally filtered by inbound or outbound direction. Returns one page and a cursor.

Input Parameters

string
required
Inclusive call end time in ISO 8601 UTC format.
string ("inbound" | "outbound")
Only return inbound or outbound calls.
string
required
Inclusive call start time in ISO 8601 UTC format.
string
Opaque continuation cursor from a prior call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_CONFIGURATION_RESOURCESList one Avoma configuration catalog: custom categories, smart categories, scorecards, templates, meeting types, or meeting outcomes. Meeting types and outcomes are returned one page at a time.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_ENGAGEMENT_METRICSList 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

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")
Metric field to order by; a leading ’-’ selects descending order.
boolean
True for voice calls, false for video meetings, or omit for both.
string
required
Inclusive ISO 8601 UTC end time.
string
required
Inclusive ISO 8601 UTC start time.
integer
Users to return on this page (1-100).
boolean
True for internal meetings, false for meetings with external attendees, or omit for both.
string
Opaque continuation cursor from a prior call; omit for the first page.
array
Email addresses of users whose engagement metrics should be included.
boolean
Filter by unscheduled or ad-hoc meetings.
array
Meeting type UUIDs to include.
boolean
Only include shared meetings when true.
array
Meeting outcome UUIDs to include.
number
Minimum recording duration in seconds.
number
Maximum recording duration in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_MEETINGSFind meetings accessible to the connected Avoma key within a required UTC date range, with optional attendee, CRM, call-type, internal/external, duration, and ordering filters. Returns one page and an opaque cursor.

Input Parameters

string ("start_at" | "-start_at")
Sort by meeting start time; prefix with ’-’ for descending.
boolean
True for voice calls, false for video meetings, or omit for both.
string
required
Inclusive meeting end time in ISO 8601 UTC format.
string
required
Inclusive meeting start time in ISO 8601 UTC format.
integer
Meetings to return on this page (1-100).
boolean
True for internal-only meetings, false for meetings with external attendees, or omit for both.
string
Opaque continuation cursor from a prior call; omit for the first page.
array
CRM lead external IDs; any match is accepted.
array
Return meetings containing any of these attendee email addresses.
array
CRM account external IDs; any match is accepted.
array
CRM contact external IDs; any match is accepted.
array
CRM opportunity external IDs; any match is accepted.
number
Minimum recording duration in seconds; excludes meetings without recordings.
boolean
Include CRM associations on returned meetings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_NOTESRetrieve a page of 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. A continuation cursor is returned when more pages are available.

Input Parameters

string ("modified" | "-modified")
Optionally order by modification time; a leading ’-’ means descending.
string
required
Inclusive meeting end time in ISO 8601 UTC format.
string
required
Inclusive meeting start time in ISO 8601 UTC format.
integer
Notes to return on this page (1-20).
string
Avoma continuation URL returned by a prior call; pass it back unchanged and omit it for the first page.
string
Only return notes for this meeting UUID.
string ("json" | "html" | "markdown")
Format for note content: json, html, or markdown.
string
Only return note content belonging to this custom category UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_SCORECARD_EVALUATIONSList Avoma scorecard evaluations, optionally filtered by UTC date range, scorecard templates, meeting, or evaluated users. Returns one page at a time.

Input Parameters

string
Inclusive ISO 8601 UTC end time.
string
Inclusive ISO 8601 UTC start time.
integer
Evaluations to return on this page (1-100).
string
Opaque continuation cursor from a prior call; omit for the first page.
array
Only return evaluations for these user email addresses.
string
Only return evaluations for this meeting UUID.
array
Scorecard template UUIDs to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_SNIPPETSFind 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_TRANSCRIPTIONSFind 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_USERSReturn users visible in the Avoma organization, including their UUID, email, role, teams, and active status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AVOMA_LIST_WEBHOOKSList Avoma webhook subscriptions returned for the connected organization, including their active status and target details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not