Skip to main content
Rev AI logo
  • Category: transcription
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 36
  • Triggers: 0
  • Slug: REV
  • Version: 20261101_00

Tools

Slug: REV_CREATE_RTMP_STREAMTool to create an RTMP live stream session for real-time transcription of live audio/video streams. Use when you need to set up streaming transcription via RTMP protocol.

Input Parameters

string
Language code for transcription in ISO 639-1 format (e.g., ‘en’, ‘es’, ‘fr’).
string
Custom metadata string to associate with the stream for tracking purposes.
string
Processing priority setting (e.g., ‘accuracy’, ‘speed’).
string
Transcriber type to use for processing (e.g., ‘machine’).
boolean
Whether to filter profanity from the transcription output.
boolean
Whether to enable detailed partial transcription results during streaming.
boolean
Whether to remove disfluencies (e.g., ‘um’, ‘uh’) from the transcription.
boolean
Whether to skip post-processing phase of transcription.
string
ID of a custom vocabulary to improve transcription accuracy for domain-specific terms.
boolean
Whether to enable speaker switching detection in the stream.
integer
Maximum duration in seconds for each transcription segment.

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: REV_DELETE_ALIGNMENT_JOBDeletes a completed forced alignment job and permanently removes its associated data.

Input Parameters

string
required
The unique identifier of the forced alignment job to delete

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: REV_DELETE_CUSTOM_VOCABULARYTool 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.

Input Parameters

string
required
Unique identifier of the custom vocabulary to delete

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: REV_DELETE_JOB_BY_IDTool 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.

Input Parameters

string
required
The unique identifier of the job to delete

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: REV_DELETE_LANGUAGE_ID_JOBTool to delete a language identification job and its associated data. Use when you need to permanently remove a language ID job that is no longer needed.

Input Parameters

string
required
The unique identifier of the language identification job to delete

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: REV_DELETE_SENTIMENT_JOBTool to delete a specific sentiment analysis job and its associated data. Use when you need to permanently remove a sentiment analysis job after confirming it’s no longer needed.

Input Parameters

string
required
The unique identifier of the sentiment analysis job to delete

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: REV_DELETE_TOPIC_EXTRACTION_JOBTool to delete a topic extraction job and its associated data. Use when you need to permanently remove a topic extraction job after confirming it’s no longer needed.

Input Parameters

string
required
The unique identifier of the topic extraction job to delete

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: REV_GET_ACCOUNTRetrieves Rev AI account information including email, credit balance (in hours), and HIPAA status. Returns current free, purchased, and total balance available for transcription services. No parameters required - uses authenticated credentials.

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: REV_GET_ALIGNMENT_JOBTool to get details of a specific forced alignment job including its status. Use when checking the progress of alignment job processing.

Input Parameters

string
required
Unique identifier of the forced alignment job to retrieve.

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: REV_GET_ALIGNMENT_TRANSCRIPTTool to retrieve the aligned transcript with timestamps for a completed alignment job. Use after confirming the alignment job status is ‘completed’.

Input Parameters

string
required
Unique identifier of the alignment job to retrieve the transcript for.

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: REV_GET_CAPTIONSTool to retrieve captions (SRT or VTT) for a completed Rev.ai transcription job. Use after confirming the job status is ‘completed’.

Input Parameters

string ("application/x-subrip" | "text/vtt")
Caption format: SRT (application/x-subrip) or WebVTT (text/vtt).
string
required
The ID of the completed transcription job.
integer
Optional audio channel number for multi-channel jobs.

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: REV_GET_CAPTIONS_TRANSLATIONTool to retrieve translated captions for a completed Rev.ai transcription job. Use after confirming the job has translation enabled and is complete.

Input Parameters

string
required
The ID of the completed transcription job that was submitted with translation enabled.
string ("application/x-subrip" | "text/vtt")
Caption format: SRT (application/x-subrip) or WebVTT (text/vtt).
string
required
The target language code for translation (e.g., ‘es’ for Spanish, ‘fr’ for French, ‘de’ for German). Must match one of the target languages specified in translation_config when the job was submitted.

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: REV_GET_CUSTOM_VOCABULARY_DETAILSTool to retrieve custom vocabulary processing details. Use when needing to fetch the status and submitted phrases for a specific custom vocabulary after creation.

Input Parameters

string
required
Unique identifier of the custom vocabulary to retrieve.

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: REV_GET_JOB_BY_IDTool to fetch details of a transcription job by its ID. Use when confirming job status and metadata are accurate.

Input Parameters

string
required
Unique identifier of the transcription job to retrieve.

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: REV_GET_LANGUAGE_ID_JOBRetrieves a language identification job by ID, including its status and basic job details.

Input Parameters

string
required
Unique identifier of the language identification job to retrieve.

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: REV_GET_LANGUAGE_ID_RESULTTool to retrieve language identification results for a completed job. Use when you need to get detected language and confidence scores for an audio file.

Input Parameters

string
required
Unique identifier of the language identification job.

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: REV_GET_LIST_OF_JOBSRetrieves a list of transcription jobs from the past 30 days in reverse chronological order (newest first). Use this tool to: - View recent transcription jobs and their statuses - Monitor job progress (in_progress, transcribed, failed) - Check job details like duration, language, and submission options - Paginate through large result sets using cursor-based pagination - Find specific jobs for further operations (get transcript, get captions, delete) Note: Jobs older than 30 days are not returned. Supports pagination up to 1000 jobs per request.

Input Parameters

integer
Maximum number of jobs to return per call. Defaults to 100 if not specified. Maximum allowed is 1000.
string
Job ID for cursor-based pagination. Returns jobs created chronologically before (but not including) this job ID. Use to paginate backwards through results.
string
Job ID for cursor-based pagination. Returns jobs created chronologically after (but not including) this job ID. Use the last job ID from a previous response to get the next page of results.

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: REV_GET_SENTIMENT_JOBTool to fetch details of a sentiment analysis job by its ID. Use when checking sentiment analysis job status and metadata.

Input Parameters

string
required
Unique identifier of the sentiment analysis job to retrieve.

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: REV_GET_SENTIMENT_RESULTTool to retrieve sentiment analysis results for a completed Rev.ai sentiment job. Use when you need to get sentiment scores and labels for transcribed content. The job must be in ‘completed’ status before results can be retrieved.

Input Parameters

string
required
Unique identifier of the sentiment analysis job. The job must be in ‘completed’ status to retrieve results.
string ("positive" | "negative" | "neutral")
Filter sentiment results by sentiment type.

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: REV_GET_TOPIC_EXTRACTION_RESULTTool to retrieve topic extraction results for a completed job. Use after confirming the topic extraction job is complete. Returns identified topics with relevance scores and supporting evidence from the content.

Input Parameters

string
required
Unique identifier of the topic extraction job to retrieve results for.
number
Optional threshold value to filter topics by score. Only topics with scores above this threshold will 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: REV_GET_TOPIC_JOBTool to fetch details of a topic extraction job by its ID. Use when you need to check the status of a topic extraction job or retrieve its metadata.

Input Parameters

string
required
Unique identifier of the topic extraction job to retrieve.

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: REV_GET_TRANSCRIPT_BY_IDTool 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.

Input Parameters

string
required
Identifier for the transcription job.
string ("application/vnd.rev.transcript.v1.0+json" | "text/plain")
Output format. Supported values: application/vnd.rev.transcript.v1.0+json (default) for JSON with timestamps and speaker info, or text/plain for plain text.

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: REV_GET_TRANSCRIPT_SUMMARYTool to retrieve a summary of the transcript for a completed transcription job. Use after confirming the job is complete and was submitted with summarization_config enabled.

Input Parameters

string
required
Identifier for the completed transcription job.
string ("application/vnd.rev.transcript.v1.0+json" | "text/plain")
Output format. Supported values: text/plain (default) for plain text summary, or application/vnd.rev.transcript.v1.0+json for JSON format with metadata.

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: REV_GET_TRANSCRIPT_TRANSLATIONTool to retrieve a translated version of the transcript for a completed Rev.ai job. Use after confirming job is complete and translation was requested when submitting the job.

Input Parameters

string
required
The ID of the transcription job.
string ("application/vnd.rev.transcript.v1.0+json" | "text/plain")
Output format. Supported values: application/vnd.rev.transcript.v1.0+json (default) for JSON with timestamps and speaker info, or text/plain for plain text.
string
required
The target language code for translation (e.g., ‘es’ for Spanish, ‘fr’ for French, ‘de’ for German).

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: REV_LIST_ALIGNMENT_JOBSLists forced alignment jobs submitted within the last 30 days in reverse chronological order, with a limit and cursor for pagination. Use it to monitor job statuses and details.

Input Parameters

integer
Maximum number of alignment jobs to return per call. Defaults to 100.
string
Job ID for cursor-based pagination. Returns jobs created chronologically after (but not including) this job ID. Use the last job ID from a previous response to get the next page of results.

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: REV_LIST_CUSTOM_VOCABULARIESLists recent custom vocabularies for the account, with a configurable result limit. Use it to view vocabulary processing information.

Input Parameters

integer
Maximum number of custom vocabularies to return. Defaults to 100 if not specified.

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: REV_LIST_LANGUAGE_ID_JOBSTool to retrieve a list of language identification jobs for the account. Use when you need to check the status of language identification jobs or monitor their progress.

Input Parameters

integer
Maximum number of jobs to return per call. Defaults to 100.
string
Job ID for cursor-based pagination. Returns jobs created chronologically after (but not including) this job ID. Use the last job ID from a previous response to get the next page of results.

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: REV_LIST_SENTIMENT_JOBSRetrieve a page of sentiment analysis jobs for the account, with a limit and cursor for pagination. Use it to review job history and statuses or find jobs for further operations.

Input Parameters

integer
Maximum number of jobs to return per call. Defaults to 100 if not specified. Maximum allowed is 1000.
string
Job ID for cursor-based pagination. Returns jobs created chronologically after (but not including) this job ID. Use the last job ID from a previous response to get the next page of results.

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: REV_LIST_TOPIC_JOBSRetrieve a page of topic extraction jobs for the account, with a limit and cursor for pagination. Use it to review job history and statuses or find jobs for further operations.

Input Parameters

integer
Maximum number of jobs to return per call. Defaults to 100 if not specified. Maximum allowed is 1000.
string
Job ID for cursor-based pagination. Returns jobs created chronologically after (but not including) this job ID. Use the last job ID from a previous response to get the next page of results.

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: REV_START_STREAM_TRANSCRIPTIONConstruct a WebSocket URL for real-time Rev.ai transcription using a Bearer access token and streaming options. Connect to the returned URL to start the stream.

Input Parameters

string
Language code in ISO 639-1 format for transcription, default ‘en’.
string
Optional user metadata string to associate with the stream.
string ("speed" | "quality")
Priority of transcription processing: ‘speed’ or ‘quality’.
number
Initial timestamp (in seconds) from which to start transcription.
string
Select a transcriber model, if multiple are available.
string
required
Audio MIME type and parameters (e.g., ‘audio/x-raw;layout=interleaved;rate=16000;format=S16LE;channels=1’, ‘audio/x-wav’, ‘audio/x-flac’).
boolean
Whether to filter profanity from transcripts.
boolean
Whether to send detailed partial results.
boolean
Whether to remove disfluencies (um, uh) from transcripts.
boolean
Whether to skip post-processing phase.
string
ID of a custom vocabulary to apply, if available.
integer
If set, server will delete the stream results after given seconds.
boolean
Whether to enable speaker-switch detection.
integer
Maximum seconds to wait for WebSocket connection establishment.
integer
Maximum duration in seconds of each transcription segment.

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: REV_SUBMIT_ALIGNMENT_JOBTool to submit an audio file with existing transcript for forced alignment. Use when you need to add accurate timestamps to transcript text by aligning it with the corresponding audio file. Forced alignment is useful when you already have a transcript but need precise word-level or phrase-level timestamps. Both the audio file and transcript must be publicly accessible via HTTP(S) URLs.

Input Parameters

string ("en" | "es" | "fr")
Language of the audio and transcript. Must be one of: en (English), es (Spanish), fr (French). Default is English (en)
string
Custom metadata string (up to 512 chars) stored with the alignment job. Useful for tracking job context, order IDs, user IDs, etc.
object
required
Configuration specifying the audio file URL to be aligned
object
Optional webhook configuration for job completion notifications.
integer
Automatically delete the completed alignment job and its data after this many seconds. Useful for managing storage and privacy. Set to 0 to delete immediately after completion
object
required
Configuration specifying the transcript text file URL to be aligned with the audio

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: REV_SUBMIT_CUSTOM_VOCABULARYSubmits a custom vocabulary to Rev.ai for improved speech recognition accuracy on domain-specific terms. The vocabulary is processed asynchronously and returns immediately with an ‘in_progress’ status. Use the returned vocabulary ID in transcription jobs to boost recognition of your custom phrases. Common use cases: brand names, technical jargon, medical terms, product names, industry acronyms. Rate limit: 150 requests per 2 minutes.

Input Parameters

array
required
List of phrases or words to boost in speech recognition. Each phrase must: contain only ASCII letters and punctuation (U+0000-U+007F, no numbers or accented characters), have at least one letter, and be 34 characters or less per word. Best practice: use 500 or fewer short phrases (5 words or less each) for optimal accuracy. API limit: 6000 phrases for English, 1000 for other languages.
string
Optional user-defined metadata string to store additional context about the vocabulary (e.g., domain, version, purpose). This is returned with the vocabulary details for reference.
string
Optional client-provided identifier for the custom vocabulary. If not provided, Rev.ai will auto-generate an ID. Use this to track vocabularies in your system.

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: REV_SUBMIT_LANGUAGE_ID_JOBSubmit an audio file by source URL for asynchronous language identification, returning a job ID for tracking the result.

Input Parameters

string
Custom metadata string (up to 512 chars) stored with the job and returned in responses. Useful for tracking job context, order IDs, user IDs, etc.
object
required
Configuration specifying the audio source URL to analyze
object
Configuration for webhook notifications when the job completes.
integer
Automatically delete the completed job and its data after this many seconds. Useful for managing storage and privacy. Set to 0 to delete immediately after completion

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: REV_SUBMIT_SENTIMENT_ANALYSIS_JOBSubmit text for sentiment analysis to detect positive, negative, or neutral sentiments. Use when analyzing customer feedback, reviews, support tickets, or transcribed audio for emotional tone. Provide either plain text (text parameter) or a Rev AI transcript JSON (transcript_json parameter). The job processes asynchronously; use the returned job ID to retrieve results when complete.

Input Parameters

string
Plain text content to analyze for sentiment. Use this when submitting raw text for analysis
string
Language code for the text content (e.g., ‘en’ for English, ‘es’ for Spanish). Required if using non-English text
string
Custom metadata string stored with the job and returned in responses. Useful for tracking job context, order IDs, user IDs, etc.
object
JSON transcript structure from Rev AI speech-to-text API.
object
Webhook configuration for job completion notifications.
integer
Time in seconds after which the job will be automatically deleted. Useful for managing storage and privacy

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: REV_SUBMIT_TOPIC_EXTRACTION_JOBTool to submit text or transcripts for topic extraction to identify key topics and themes. Use when analyzing conversation content, meeting transcripts, or text to extract main discussion points. Supports both plain text input (up to 14000 words) and structured JSON transcripts from Rev.ai’s Speech-to-Text API. Results are processed asynchronously; use the returned job ID to check status and retrieve extracted topics when complete.

Input Parameters

object
JSON transcript format from Rev.ai Speech-to-Text API.
string
Plain text content to analyze for topic extraction. Maximum 14000 words. Use this for simple text input
string
Language code for the content (e.g., ‘en’, ‘es’, ‘fr’). If not specified, language may be auto-detected from the content
string
Custom metadata string (up to 512 chars) stored with the job and returned in responses. Useful for tracking job context, order IDs, user IDs, etc.
object
Configuration for webhook notifications when job completes.
integer
Automatically delete the completed job and its data after this many seconds. Useful for managing storage and privacy. Set to 0 to delete immediately after completion

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: REV_SUBMIT_TRANSCRIPTION_JOBSubmit an audio or video file for asynchronous transcription using Rev.ai. Use this action to convert speech to text from media files. Provide either a publicly accessible URL (media_url) or upload file bytes directly. The job processes asynchronously; use the returned job ID to check status and retrieve the transcript when complete. Supports speaker diarization, punctuation, profanity filtering, custom vocabularies, and multiple languages.

Input Parameters

string
Binary audio/video content to upload directly (use when media_url is not available). File size limit: 2GB for direct uploads
string
Language code for the audio (ISO 639-1 or BCP-47 format, lowercase). Supports English, Spanish, French, German, Portuguese, Italian, and 40+ others. Use ‘auto’ for automatic detection. Note: filter_profanity and skip_punctuation are only available for English transcription
string
Custom metadata string (up to 512 chars) stored with the job and returned in responses. Useful for tracking job context, order IDs, user IDs, etc.
string
Publicly accessible HTTP(S) URL of the audio/video file to transcribe. Supports formats like MP3, MP4, WAV, FLAC, Ogg, and others supported by FFmpeg. File size limit: 5TB via URL
string
HTTPS URL where Rev.ai will POST a notification when transcription completes. Webhook receives the job object as JSON
boolean
Set to true to replace profane words with asterisks in the transcript. Default false returns raw transcription without filtering
boolean
Set to true to disable speaker diarization (identifying different speakers). Default false means speakers will be labeled as ‘Speaker 1’, ‘Speaker 2’, etc.
boolean
Set to true to disable automatic punctuation in the transcript. Default false adds periods, commas, question marks, etc.
object
Configuration for automatic transcript translation into target languages.
array
List of custom vocabulary IDs to improve transcription accuracy for domain-specific terms, proper nouns, technical jargon, or brand names. Submit vocabularies separately first
integer
Automatically delete the completed job and its data after this many seconds. Useful for managing storage and privacy. Set to 0 to delete immediately after completion
object
Advanced settings for controlling transcription behavior and output format.
integer
Number of audio channels to treat as separate speakers (for multi-channel audio files). Each channel will be transcribed separately and attributed to a different speaker. Use when you have recordings with isolated speaker tracks

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