Rev ai

Learn how to use Rev ai with Composio

Overview

SLUG: REV_AI

Description

Rev AI provides advanced machine learning and speech recognition services for converting audio and video to text.

Authentication Details

bearer_token
stringRequired

Connecting to Rev ai

Create an auth config

Use the dashboard to create an auth config for the Rev ai toolkit. This allows you to connect multiple Rev ai accounts to Composio for agents to use.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Rev ai Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4rev_ai_auth_config_id = "ac_YOUR_REV_AI_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Rev ai for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, rev_ai_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Rev ai toolkit’s playground](https://app.composio.dev/app/Rev ai)

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Delete Custom Vocabulary

Description

Tool to delete a completed custom vocabulary and its data. Use when you need to remove an unused vocabulary after confirming it's no longer needed.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Job By ID

Description

Tool to delete a completed transcription job and its data. Use when you need to permanently remove a finished job after confirming it's no longer needed.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Account

Description

Tool to retrieve developer account details. Use after authenticating with Rev AI.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Captions

Description

Tool to retrieve captions (SRT or VTT) for a completed Rev.ai transcription job. Use after confirming the job status is 'completed'.

Action Parameters

accept
stringDefaults to application/x-subrip
channel_id
job_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Custom Vocabulary Details

Description

Tool to retrieve custom vocabulary processing details. Use when needing to fetch the status and submitted phrases for a specific custom vocabulary after creation.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Job by ID

Description

Tool to fetch details of a transcription job by its ID. Use when confirming job status and metadata are accurate.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get List of Jobs

Description

Tool to get list of transcription jobs from the past 30 days. Use when you need to retrieve and paginate through recent transcription tasks.

Action Parameters

ending_before
limit
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Transcript by ID

Description

Tool to retrieve the transcript of a completed Rev.ai job. Use after confirming job is complete. Supports JSON format (with timestamps and speaker info) or plain text format.

Action Parameters

accept
Defaults to application/vnd.rev.transcript.v1.0+json
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Start Stream Transcription

Description

Tool to start a WebSocket transcription stream. Use when you need real-time speech-to-text streaming via Rev.ai.

Action Parameters

content_type
stringRequired
custom_vocabulary_id
delete_after_seconds
detailed_partials
enable_speaker_switch
filter_profanity
language
Defaults to en
max_connection_wait_seconds
Defaults to 60
max_segment_duration_seconds
metadata
priority
Defaults to speed
remove_disfluencies
skip_postprocessing
start_ts
transcriber

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Submit Custom Vocabulary

Description

Tool to submit a custom vocabulary for improved speech recognition. Use when you want to process domain-specific terms asynchronously.

Action Parameters

custom_vocabulary_id
metadata
phrases
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Submit Transcription Job

Description

Tool to submit a new transcription job. Use when you have a media URL or file bytes ready for async processing.

Action Parameters

callback_url
custom_vocabularies
delete_after_seconds
file
filter_profanity
boolean
language
media_url
metadata
skip_diarization
boolean
skip_punctuation
boolean
speaker_channel_count
transcription_config

Action Response

data
objectRequired
error
successful
booleanRequired