Sonix ACTION
Upload Media
Submits new media for processing. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Sonix account once, then configure and run Upload Media from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "sonix-upload-media",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
sonix: { authProvisionId: "apn_xxxxxxx" },
file: "File Path or URL",
language: "Language",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "sonix-upload-media",
"configured_props": {
"sonix": { "authProvisionId": "apn_xxxxxxx" },
"file": "File Path or URL",
"language": "Language"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "sonix",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "sonix-upload-media",
arguments: {
file: "File Path or URL",
language: "Language",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
file File Path or URL | string | The audio or video file to upload (max 100MB). Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.txt) Required |
language Language | string | Language code for the transcription. Required |
folderId Folder ID | string | ID of folder to place the media in Optional Dynamic |
name Name | string | Name of the file in Sonix. If no name is provided, we will default to the filename. Optional |
transcriptText Transcript Text | boolean | Existing transcript - if present, will align the transcript rather than transcribing. Optional |
keywords Keywords | string[] | 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 |
customData Custom Data | object | Set of key-value pairs that you can attach to the media. This can be useful for storing additional information about file. Optional |
callbackUrl Callback URL | string | 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 |
syncDir SyncDir | dir | Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- sonix-upload-media
- Version
- 1.0.4
- App
- Sonix
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗