← Sonix

Upload Media with Sonix API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Upload Media with the Sonix API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Upload Media with the Sonix API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Upload Media action
    1. Connect your Sonix account
    2. Optional- Configure File
    3. Optional- Configure File URL
    4. Select a Language
    5. Optional- Select a Folder ID
    6. Optional- Configure Name
    7. Optional- Configure Transcript Text
    8. Optional- Configure Keywords
    9. Optional- Configure Custom Data
    10. Optional- Configure Callback URL
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Upload Media with Sonix API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Sonix
 
Try it
Upload Media with Sonix API on New Submission from Typeform API
Typeform + Sonix
 
Try it
Upload Media with Sonix API on Custom Events from Zoom API
Zoom + Sonix
 
Try it
Upload Media with Sonix API on New Submission (Instant) from Jotform API
Jotform + Sonix
 
Try it
Upload Media with Sonix API on New Scheduled Tasks from Pipedream API
Pipedream + Sonix
 
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.

Upload Media on Sonix
Description:Submits new media for processing. [See the documentation](https://sonix.ai/docs/api#new_media)
Version:0.0.1
Key:sonix-upload-media

Code

import { ConfigurationError } from "@pipedream/platform";
import FormData from "form-data";
import fs from "fs";
import { LANGUAGE_OPTIONS } from "../../common/constants.mjs";
import { checkTmp } from "../../common/utils.mjs";
import sonix from "../../sonix.app.mjs";

export default {
  key: "sonix-upload-media",
  name: "Upload Media",
  description: "Submits new media for processing. [See the documentation](https://sonix.ai/docs/api#new_media)",
  version: "0.0.1",
  type: "action",
  props: {
    sonix,
    file: {
      type: "string",
      label: "File",
      description: "Path of the audio or video file in /tmp folder. The limit is 100MB using this parameter. For larger files, use **File URL**. `NOTE: Only one of **File** or **File URL** is required.` To upload a file to /tmp folder, please follow the [doc here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
      optional: true,
    },
    fileUrl: {
      type: "string",
      label: "File URL",
      description: "URL pointing to the audio/video file. `NOTE: Only one of **File** or **File URL** is required.`",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "Language code for the transcription.",
      options: LANGUAGE_OPTIONS,
    },
    folderId: {
      propDefinition: [
        sonix,
        "folderId",
      ],
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the file in Sonix. If no name is provided, we will default to the filename.",
      optional: true,
    },
    transcriptText: {
      type: "boolean",
      label: "Transcript Text",
      description: "Existing transcript - if present, will align the transcript rather than transcribing.",
      optional: true,
    },
    keywords: {
      type: "string[]",
      label: "Keywords",
      description: "Comma separated list of words or phrases to use as hints to the transcription engine. If this is provided, then the account level keywords will not be used.",
      optional: true,
    },
    customData: {
      type: "object",
      label: "Custom Data",
      description: "Set of key-value pairs that you can attach to the media. This can be useful for storing additional information about file.",
      optional: true,
    },
    callbackUrl: {
      type: "string",
      label: "Callback URL",
      description: "URL for Sonix to make a POST request notifying of a change in transcript status (either failed or completed). The POST will include the media status JSON.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.file && !this.fileUrl) {
      throw new ConfigurationError("You must provite whether **File** or **File URL**.");
    }

    const formData = new FormData();

    if (this.file) {
      const filePath = checkTmp(this.file);
      formData.append("file", fs.createReadStream(filePath));
    }

    this.fileUrl && formData.append("file_url", this.fileUrl);
    this.language && formData.append("language", this.language);
    this.name && formData.append("name", this.name);
    this.transcriptText && formData.append("transcript_text", `${this.transcriptText}`);
    this.folderId && formData.append("folder_id", this.folderId);
    this.keywords && formData.append("keywords", this.keywords.toString());
    this.customData && formData.append("custom_data", JSON.stringify(this.customData));
    this.callbackUrl && formData.append("callback_url", this.callbackUrl);

    const response = await this.sonix.submitNewMedia({
      data: formData,
      headers: formData.getHeaders(),
    });
    $.export("$summary", `Successfully uploaded media with ID: ${response.id}`);
    return response;
  },
};

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.
LabelPropTypeDescription
SonixsonixappThis component uses the Sonix app.
Filefilestring

Path of the audio or video file in /tmp folder. The limit is 100MB using this parameter. For larger files, use File URL. NOTE: Only one of **File** or **File URL** is required. To upload a file to /tmp folder, please follow the doc here

File URLfileUrlstring

URL pointing to the audio/video file. NOTE: Only one of **File** or **File URL** is required.

LanguagelanguagestringSelect a value from the drop down menu:{ "label": "English", "value": "en" }{ "label": "French", "value": "fr" }{ "label": "German", "value": "de" }{ "label": "Spanish", "value": "es" }{ "label": "Arabic", "value": "ar" }{ "label": "Armenian", "value": "hy-AM" }{ "label": "Bulgarian", "value": "bg" }{ "label": "Catalan", "value": "ca" }{ "label": "Croatian", "value": "hr" }{ "label": "Chinese (Cantonese)", "value": "yue-Hant-HK" }{ "label": "Chinese (Mandarin)", "value": "cmn-Hans-CN" }{ "label": "Czech", "value": "cs" }{ "label": "Danish", "value": "da" }{ "label": "Dutch", "value": "nl" }{ "label": "Finnish", "value": "fi" }{ "label": "Greek", "value": "el" }{ "label": "Hebrew", "value": "he-IL" }{ "label": "Hindi", "value": "hi" }{ "label": "Hungarian", "value": "hu" }{ "label": "Indonesian", "value": "id-ID" }{ "label": "Italian", "value": "it" }{ "label": "Japanese", "value": "ja" }{ "label": "Korean", "value": "ko" }{ "label": "Latvian", "value": "lv" }{ "label": "Lithuanian", "value": "lt" }{ "label": "Malay", "value": "ms-MY" }{ "label": "Norwegian", "value": "nb-NO" }{ "label": "Polish", "value": "pl" }{ "label": "Portuguese", "value": "pt" }{ "label": "Romanian", "value": "ro" }{ "label": "Russian", "value": "ru" }{ "label": "Slovak", "value": "sk" }{ "label": "Slovenian", "value": "sl" }{ "label": "Swedish", "value": "sv" }{ "label": "Thai", "value": "th-TH" }{ "label": "Turkish", "value": "tr-TR" }{ "label": "Ukrainian", "value": "uk" }{ "label": "Vietnamese", "value": "vi-VN" }
Folder IDfolderIdstringSelect a value from the drop down menu.
Namenamestring

Name of the file in Sonix. If no name is provided, we will default to the filename.

Transcript TexttranscriptTextboolean

Existing transcript - if present, will align the transcript rather than transcribing.

Keywordskeywordsstring[]

Comma separated list of words or phrases to use as hints to the transcription engine. If this is provided, then the account level keywords will not be used.

Custom DatacustomDataobject

Set of key-value pairs that you can attach to the media. This can be useful for storing additional information about file.

Callback URLcallbackUrlstring

URL for Sonix to make a POST request notifying of a change in transcript status (either failed or completed). The POST will include the media status JSON.

Authentication

Sonix uses API keys for authentication. When you connect your Sonix account, Pipedream securely stores the keys so you can easily authenticate to Sonix APIs in both code and no-code steps.

About Sonix

Automated transcription, translation, and subtitling. Over 40 languages supported. Fast, accurate, and affordable.

More Ways to Use Sonix

Triggers

New Media Upload Complete from the Sonix API

Emit new event any time the media status of an item changes to completed.

 
Try it

Actions

Create New Translation with the Sonix API

Creates a new translation for a selected media file. See the documentation

 
Try it
Get Text Transcript with the Sonix API

Gets the text transcript of a selected media file. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.