Submit Transcription Job with Rev.ai API

Pipedream makes it easy to connect APIs for Rev.ai and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Submit Transcription Job with the Rev.ai API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Submit Transcription Job with the Rev.ai API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Submit Transcription Job action
1. Connect your Rev.ai account
2. Configure media_url
3. Optional- Configure skip_diarization
4. Optional- Configure skip_punctuation
5. Optional- Configure remove_disfluencies
6. Optional- Configure filter_profanity
7. Optional- Configure speaker_channels_count
8. Optional- Configure delete_after_seconds
9. Optional- Configure metadata
10. Optional- Configure callback_url
11. Optional- Configure phrases
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Submit Transcription Job with Rev.ai API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Rev.ai

Try it

Submit Transcription Job with Rev.ai API on New Item in Feed from RSS API

RSS + Rev.ai

Try it

Submit Transcription Job with Rev.ai API on New Message from Discord API

Discord + Rev.ai

Try it

Submit Transcription Job with Rev.ai API on New Message In Channels from Slack API

Slack + Rev.ai

Try it

Submit Transcription Job with Rev.ai API on New Message in Channel from Discord Bot API

Discord Bot + Rev.ai

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Submit Transcription Job on Rev.ai

Description:Starts an asynchronous job to transcribe speech-to-text for a media file. Add an optional callback URL to invoke when processing is complete.

Version:0.1.1

Key:rev_ai-submit-transcription-job

View on GitHub

Code#

// legacy_hash_id: a_NqiqvY
import { axios } from "@pipedream/platform";

export default {
  key: "rev_ai-submit-transcription-job",
  name: "Submit Transcription Job",
  description: "Starts an asynchronous job to transcribe speech-to-text for a media file. Add an optional callback URL to invoke when processing is complete.",
  version: "0.1.1",
  type: "action",
  props: {
    rev_ai: {
      type: "app",
      app: "rev_ai",
    },
    media_url: {
      type: "string",
      description: "Direct download media url. Ignored if submitting job from file",
    },
    skip_diarization: {
      type: "boolean",
      description: "Specify if speaker diarization will be skipped by the speech engine",
      optional: true,
    },
    skip_punctuation: {
      type: "boolean",
      description: "Specify if \"punct\" type elements will be skipped by the speech engine. For JSON outputs, this includes removing spaces. For text outputs, words will still be delimited by a space",
      optional: true,
    },
    remove_disfluencies: {
      type: "boolean",
      description: "Currently we only define disfluencies as 'ums' and 'uhs'. When set to true, disfluencies will be not appear in the transcript.",
      optional: true,
    },
    filter_profanity: {
      type: "boolean",
      description: "Enabling this option will filter for approx. 600 profanities, which cover most use cases. If a transcribed word matches a word on this list, then all the characters of that word will be replaced by asterisks except for the first and last character.",
      optional: true,
    },
    speaker_channels_count: {
      type: "integer",
      description: "Use to specify the total number of unique speaker channels in the audio.\n\nGiven the number of audio channels provided, each channel will be transcribed separately and the channel id assigned to the speaker label. The final output will be a combination of all individual channel outputs. Overlapping monologues will have ordering broken by the order in which the first spoken element of each monologue occurs. If speaker_channels_count is greater than the actual channels in the audio, the job will fail with invalid_media.\n\nNote:\n\nThe amount charged will be the duration of the file multiplied by the number of channels specified.\nWhen using speaker_channels_count each channel will be diarized as one speaker, and the value of skip_diarization will be ignored if provided",
      optional: true,
    },
    delete_after_seconds: {
      type: "integer",
      description: "Specify the number of seconds after job completion when job is auto-deleted. It may take up to 2 minutes after the scheduled time for the job to be deleted. The number of seconds provided must range from `0` seconds to `2592000` seconds (30 days).",
      optional: true,
    },
    metadata: {
      type: "string",
      description: "Optional metadata that was provided during submission",
      optional: true,
    },
    callback_url: {
      type: "string",
      description: "Optional callback url to invoke when processing is complete",
      optional: true,
    },
    phrases: {
      type: "any",
      description: "Array of phrases not found in normal dictionary. Add technical jargon, proper nouns and uncommon phrases as strings in this array to add them to the lexicon for this job.\n\nA phrase must contain at least 1 alpha character but may contain any non-numeric character from the Basic Latin set. A phrase can contain up to 12 words. Each word can contain up to 34 characters.",
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      "media_url": this.media_url,
      "skip_diarization": this.skip_diarization,
      "skip_punctuation": this.skip_punctuation,
      "remove_disfluencies": this.remove_disfluencies,
      "filter_profanity": this.filter_profanity,
      "speaker_channels_count": this.speaker_channels_count,
      "delete_after_seconds": this.delete_after_seconds,
      "metadata": this.metadata,
      "callback_url": this.callback_url,
    };

    if (this.phrases) {
      data.phrases = {
        "custom_vocabularies": [
          {
            "phrases": this.phrases,
          },
        ],
      };
    }

    return await axios($, {
      url: "https://api.rev.ai/speechtotext/v1/jobs",
      method: "post",
      headers: {
        Authorization: `Bearer ${this.rev_ai.$auth.access_token}`,
      },
      data,
    });
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Rev.ai	`rev_ai`	`app`	This component uses the Rev.ai app.
	`media_url`	`string`	Direct download media url. Ignored if submitting job from file
	`skip_diarization`	`boolean`	Specify if speaker diarization will be skipped by the speech engine
	`skip_punctuation`	`boolean`	Specify if "punct" type elements will be skipped by the speech engine. For JSON outputs, this includes removing spaces. For text outputs, words will still be delimited by a space
	`remove_disfluencies`	`boolean`	Currently we only define disfluencies as 'ums' and 'uhs'. When set to true, disfluencies will be not appear in the transcript.
	`filter_profanity`	`boolean`	Enabling this option will filter for approx. 600 profanities, which cover most use cases. If a transcribed word matches a word on this list, then all the characters of that word will be replaced by asterisks except for the first and last character.
	`speaker_channels_count`	`integer`	Use to specify the total number of unique speaker channels in the audio. Given the number of audio channels provided, each channel will be transcribed separately and the channel id assigned to the speaker label. The final output will be a combination of all individual channel outputs. Overlapping monologues will have ordering broken by the order in which the first spoken element of each monologue occurs. If speaker_channels_count is greater than the actual channels in the audio, the job will fail with invalid_media. Note: The amount charged will be the duration of the file multiplied by the number of channels specified. When using speaker_channels_count each channel will be diarized as one speaker, and the value of skip_diarization will be ignored if provided
	`delete_after_seconds`	`integer`	Specify the number of seconds after job completion when job is auto-deleted. It may take up to 2 minutes after the scheduled time for the job to be deleted. The number of seconds provided must range from `0` seconds to `2592000` seconds (30 days).
	`metadata`	`string`	Optional metadata that was provided during submission
	`callback_url`	`string`	Optional callback url to invoke when processing is complete
	`phrases`	`any`	Array of phrases not found in normal dictionary. Add technical jargon, proper nouns and uncommon phrases as strings in this array to add them to the lexicon for this job. A phrase must contain at least 1 alpha character but may contain any non-numeric character from the Basic Latin set. A phrase can contain up to 12 words. Each word can contain up to 34 characters.