CONNECT APP
Build with Amara
The Amara Editor is an award-winning caption and subtitle editor that’s free to use! It’s fun and easy to learn, and encourages collaboration.
Productivity
- API key
MCP
Give your agent Amara tools
Every Amara action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Amara account for each tool call — you store no tokens.
// 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": "amara",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add New Subtitles:
const result = await mcp.callTool({
name: "amara-add-new-subtitles",
arguments: {
team: "Team",
videoId: "Video ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"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": "amara",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add New Subtitles:
result = await session.call_tool("amara-add-new-subtitles", {
"team": "Team",
"videoId": "Video ID",
})API PROXY
Call the Amara API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Amara API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://amara.org/api/users/teams/",
})
// Any allowed Amara endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://amara.org/api/users/teams/
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hbWFyYS5vcmcvYXBpL3VzZXJzL3RlYW1zLw?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Amara actions from your backend
Connect a user's Amara account once, then run Add New Subtitles on their behalf from your own code — TypeScript, Python, or plain HTTP.
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: "amara-add-new-subtitles",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
amara: { authProvisionId: "apn_xxxxxxx" },
team: "Team",
videoId: "Video ID",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="amara-add-new-subtitles",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"amara": {"authProvisionId": "apn_xxxxxxx"},
"team": "Team",
"videoId": "Video ID",
},
)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": "amara-add-new-subtitles",
"configured_props": {
"amara": { "authProvisionId": "apn_xxxxxxx" },
"team": "Team",
"videoId": "Video ID"
}
}'TOOLS
Amara actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add New Subtitles
actionAdd new subtitles. See the docs hereWritev0.0.3 -
Add Video
actionAdd a video. See the docs hereWritev0.0.3 -
Create Subtitle Language
actionCreate a subtitle language. See the docs hereWritev0.0.3 -
Delete Subtitles
actionDelete all subtitle versions for a language. See the docs hereWritev0.0.3 -
Delete Video
actionDelete a video. In order to delete a video, it must be part of a team that you're an admin of. See the docs hereWritev0.0.4 -
Fetch Raw Subtitles
actionFetch raw subtitles. See the docs hereWritev0.0.3 -
Fetch Subtitles Data
actionFetch subtitles data. See the docs hereWritev0.0.3 -
Get Subtitle Language Details
actionGet details on a single subtitle language. See the docs hereRead-onlyv0.0.3 -
Get Team Details
actionGet details on a team. See the docs hereRead-onlyv0.0.3 -
Get Video Details
actionGet video details. See the docs hereRead-onlyv0.0.3 -
List Primary Audio Language Code Options
actionRetrieves Available Options for the Primary Audio Language Code Field.Read-onlyv0.0.1 -
List Teams
actionList teams. See the docs hereRead-onlyv0.0.3 -
List Video Subtitle Languages
actionGet a list of subtitle languages for a video. See the docs hereRead-onlyv0.0.3 -
List Videos
actionList videos. See the docs hereRead-onlyv0.0.4 -
Perform Action
actionPerform an action on the subtitles. This is equivalent to opening the editor, not changing the subtitles, and clicking an actions button. See the docs hereWritev0.0.3 -
Update Subtitle Language
actionUpdate a subtitle language. See the docs hereWritev0.0.3
-
Subtitles Published
triggerEmit new event when subtitles have been published. See the docs herev0.0.3 -
Subtitles Unpublished
triggerEmit new event when subtitles have been unpublished. See the docs herev0.0.3 -
Video Added
triggerEmit new event when a video is added. See the docs herev0.0.3 -
Video Deleted
triggerEmit new event when a video is deleted. See the docs herev0.0.3 -
Video Made Primary
triggerEmit new event when a video has been made primary. See the docs herev0.0.3 -
Video Moved Project
triggerEmit new event when a video has been moved from project. See the docs herev0.0.3
- App slug
- amara
- Authentication
- API key
- Categories
- Productivity
- Actions
- 16
- Triggers
- 6
- API proxy
- Available