The Amara connector lets your AI agent act in each user's Amara account. Each user connects their own Amara API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 42 tools.
- Tools
- 42
- What they doRead · write · destructive
- 23 · 14 · 523 read14 write5 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Amara connection
In AgentKit > Connections, create an Amara connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'amara'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Amara:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'amara_supported_languages_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "amara"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Amara:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="amara_supported_languages_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Amara credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolamara_language_getGet one subtitle language of a video with its versions and completion state.Read-onlyGet Subtitle Language
Get one subtitle language of a video with its versions and completion state. Get the video ID from amara_videos_list.
Inputs
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
amara_languages_listList the subtitle languages of a video with completion, publish state, versions and limits.Read-onlyList Subtitle Languages
List the subtitle languages of a video with completion, publish state, versions and limits. Get the video ID from amara_videos_list.
Inputs
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
amara_project_getGet one team project with its guidelines.Read-onlyGet Project
Get one team project with its guidelines. Get the project slug from amara_projects_list.
Inputs
project_slugstringrequired- Project Slug. Example: season-1
team_slugstringrequired- Team Slug. Example: my-team
amara_projects_listList a team's projects.Read-onlyList Projects
List a team's projects. Get the team slug from amara_teams_list.
Inputs
team_slugstringrequired- Team Slug. Example: my-team
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
amara_subtitle_actions_listList the workflow actions (such as save-draft, publish, approve, reject) available for a subtitle language.Read-onlyList Subtitle Actions
List the workflow actions (such as save-draft, publish, approve, reject) available for a subtitle language. Run one with amara_subtitle_action_perform.
Inputs
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
amara_subtitle_notes_listList the editor notes left on a subtitle language.Read-onlyList Subtitle Notes
List the editor notes left on a subtitle language. Get the video ID from amara_videos_list.
Inputs
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
amara_subtitle_request_getGet one subtitle request with its stage, assignees and due dates.Read-onlyGet Subtitle Request
Get one subtitle request with its stage, assignees and due dates. Get the job ID from amara_subtitle_requests_list.
Inputs
job_idstringrequired- Job ID. Example: AbC12dE
team_slugstringrequired- Team Slug. Example: my-team
amara_subtitle_requests_listList a team's subtitle requests (jobs), by work status, video, language, project or assignee.Read-onlyList Subtitle Requests
List a team's subtitle requests (jobs), by work status, video, language, project or assignee. Use amara_subtitle_request_get for one request.
Inputs
team_slugstringrequired- Team Slug. Example: my-team
assigneestring- Filter by assignee. Example: jane
languagestring- Filter by subtitle request language. Example: es
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
projectstring- Filter by team project. Example: season-1
sortstring- Sort order. Defaults to -creation . See below for values. Example: -creation
statusstring- Filter by the overall status (see the request status fields section). Example: in-progress
typestring- Activity type to filter by (see Amara's activity types list, for example video-added or subtitles-added). Example: local
videostring- Filter by video ID. Example: NI1hLjBxuTpk
video_languagestring- Filter by video language. Example: en
video_titlestring- Filter by video title. Example: Meet Amara
work_statusstring- Filter by the status of work on the subtitles. See below for possible values. Example: complete
amara_subtitles_getGet the subtitles for a language in a format such as srt, vtt, dfxp, sbv or json, optionally for a given version.Read-onlyGet Subtitles
Get the subtitles for a language in a format such as srt, vtt, dfxp, sbv or json, optionally for a given version. Use amara_languages_list to see versions.
Inputs
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
sub_formatstring- The format to return the subtitles in. This can be any format that amara supports including dfxp, srt, vtt, and sbv. The default is json, which returns subtitle data encoded list of json dicts. Example: json
version_numberinteger- version number to fetch. Versions are listed in the VideoLanguageResouce request. If none is specified, the latest public version will be returned. If you want the latest private version (and have access to it) use “last”. Example: 2
amara_supported_languages_listList every language code Amara supports with its name.Read-onlyList Languages
List every language code Amara supports with its name. Use these codes for subtitle and video language fields.
Inputs
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
amara_team_activity_listList activity on a team's videos, by type, user, video, language or date.Read-onlyList Team Activity
List activity on a team's videos, by type, user, video, language or date. Get the team slug from amara_teams_list. Users are given as a username or as id$ plus the user ID.
Inputs
team_slugstringrequired- Team Slug. Example: my-team
afterstring- Only include activity after. Example: 2026-01-01T00:00:00Z
beforestring- Only include activity before this date/time. Example: 2026-01-31T00:00:00Z
languagestring- Filter by the subtitle language. Example: es
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
typestring- Activity type to filter by (see Amara's activity types list, for example video-added or subtitles-added). Example: video-added
userstring- Filter by user who performed the action (see Specifying users in request data ). Example: id$jGvdcg-jNoGc32ySWS13tD
videostring- Filter by video. Example: NI1hLjBxuTpk
video_languagestring- Filter by video language. Example: en
amara_team_applications_listList applications to join a team, by status, user or date.Read-onlyList Team Applications
List applications to join a team, by status, user or date. Needs team admin rights.
Inputs
team_slugstringrequired- Team Slug. Example: my-team
afterstring- Include only applications submitted after this time (deprecated: UNIX timestamps are also allowed). Example: 2026-01-01T00:00:00Z
beforestring- Include only applications submitted before this time (deprecated: UNIX timestamps are also allowed). Example: 2026-01-31T00:00:00Z
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
statusstring- Include only applications with this status. Example: Approved
userstring- Include only applications from this user (see Specifying users in request data ). Example: id$jGvdcg-jNoGc32ySWS13tD
amara_team_getGet one team's details, visibility, membership and video policies.Read-onlyGet Team
Get one team's details, visibility, membership and video policies. Get the team slug from amara_teams_list.
Inputs
team_slugstringrequired- Team Slug. Example: my-team
amara_team_member_getGet one team member's role.Read-onlyGet Team Member
Get one team member's role. Get the team slug from amara_teams_list. Users are given as a username or as id$ plus the user ID.
Inputs
team_slugstringrequired- Team Slug. Example: my-team
user_identifierstringrequired- User Identifier. Example: id$jGvdcg-jNoGc32ySWS13tD
amara_team_members_listList a team's members and their roles.Read-onlyList Team Members
List a team's members and their roles. Get the team slug from amara_teams_list.
Inputs
team_slugstringrequired- Team Slug. Example: my-team
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
amara_team_notifications_listList the HTTP callback notifications Amara sent for a team, with response status.Read-onlyList Team Notifications
List the HTTP callback notifications Amara sent for a team, with response status. Use this to debug team webhooks.
Inputs
team_slugstringrequired- Team Slug. Example: my-team
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
amara_teams_listList the teams visible to the API key's user.Read-onlyList Teams
List the teams visible to the API key's user. Use the team slug with the team tools.
Inputs
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
amara_user_activity_listList a user's activity, by type, video, language, team or date.Read-onlyList User Activity
List a user's activity, by type, video, language, team or date. Users are given as a username or as id$ plus the user ID.
Inputs
identifierstringrequired- Identifier. Example: id$jGvdcg-jNoGc32ySWS13tD
afterstring- Only include activity after. Example: 2026-01-01T00:00:00Z
beforestring- Only include activity before this date/time. Example: 2026-01-31T00:00:00Z
languagestring- Filter by the subtitle language. Example: es
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
teamstring- Filter by team. Example: my-team
typestring- Activity type to filter by (see Amara's activity types list, for example video-added or subtitles-added). Example: video-added
videostring- Filter by video. Example: NI1hLjBxuTpk
video_languagestring- Filter by video language. Example: en
amara_user_getGet a user's profile: name, username, languages, bio and avatar.Read-onlyGet User
Get a user's profile: name, username, languages, bio and avatar. Pass a username or id$ plus the user ID.
Inputs
identifierstringrequired- Identifier. Example: id$jGvdcg-jNoGc32ySWS13tD
amara_video_activity_listList activity on a video (added, subtitled, approved and so on), by type, user, language or date.Read-onlyList Video Activity
List activity on a video (added, subtitled, approved and so on), by type, user, language or date. Get the video ID from amara_videos_list. Users are given as a username or as id$ plus the user ID.
Inputs
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
afterstring- Only include activity after. Example: 2026-01-01T00:00:00Z
beforestring- Only include activity before this date/time. Example: 2026-01-31T00:00:00Z
languagestring- Filter by the subtitle language. Example: es
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
typestring- Activity type to filter by (see Amara's activity types list, for example video-added or subtitles-added). Example: video-added
userstring- Filter by user who performed the action (see Specifying users in request data ). Example: id$jGvdcg-jNoGc32ySWS13tD
amara_video_getGet one video with title, duration, team, URLs and the subtitle languages started on it.Read-onlyGet Video
Get one video with title, duration, team, URLs and the subtitle languages started on it. Get the video ID from amara_videos_list.
Inputs
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
amara_video_urls_listList the media URLs attached to a video, with the primary and original flags.Read-onlyList Video URLs
List the media URLs attached to a video, with the primary and original flags. Get the video ID from amara_videos_list.
Inputs
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
amara_videos_listList videos, filtered by video URL, team, project or audio language, and ordered by title or creation date.Read-onlyList Videos
List videos, filtered by video URL, team, project or audio language, and ordered by title or creation date. Pass team (and optionally project) to list a team's videos. Use amara_video_get for one video.
Inputs
limitinteger- Page size (default 20). Example: 20
offsetinteger- Number of results to skip. Example: 0
order_bystring- Change the list ordering. One of: title, -title, created, -created. Example: -createdone of
title-titlecreated-created primary_audio_language_codestring- Filter team videos by video language (only works when the team parameter is also present). Example: en
projectstring- Filter by team project. Passing in null will return only videos that don’t belong to a project. Example: season-1
teamstring- Filter by team. Passing in null will return only videos that are in the public area. Example: my-team
video_urlstring- Filter by video URL. Example: https://www.youtube.com/watch?v=aQ-xe-GSjdA
amara_language_createStart a subtitle language on a video, with optional primary-audio and complete flags and editor limits.WriteCreate Subtitle Language
Start a subtitle language on a video, with optional primary-audio and complete flags and editor limits. Then add subtitles with amara_subtitles_add. Get the video ID from amara_videos_list.
Inputs
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
is_primary_audio_languageboolean- Is this the primary spoken language of the video? (optional). Example: true
language_codestring- bcp-47 code for the language. Example: en
soft_limit_cplinteger- Controls the max characters per line for subtitles. A warning is shown in the editor if this limit is exceeded. Example: 42
soft_limit_cpsinteger- Controls the max characters per second for subtitles. A warning is shown in the editor if this limit is exceeded. Example: 25
soft_limit_linesinteger- Controls the max number of lines per subtitle. A warning is shown in the editor if this limit is exceeded. Example: 2
soft_limit_max_durationinteger- Controls max duration of subtitles in milliseconds. This controls the message in the guidelines dialog. Example: 25
soft_limit_min_durationinteger- Controls min duration of subtitles in milliseconds. A warning is shown in the editor if this limit is exceeded. Example: 25
subtitles_completeboolean- Are the subtitles for this language complete? (optional). Example: true
amara_language_updateUpdate a subtitle language's primary-audio and complete flags or editor limits.WriteUpdate Subtitle Language
Update a subtitle language's primary-audio and complete flags or editor limits. Get the video ID from amara_videos_list.
- Idempotent
Inputs
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
is_primary_audio_languageboolean- Is this the primary spoken language of the video? (optional). Example: true
soft_limit_cplinteger- Controls the max characters per line for subtitles. A warning is shown in the editor if this limit is exceeded. Example: 42
soft_limit_cpsinteger- Controls the max characters per second for subtitles. A warning is shown in the editor if this limit is exceeded. Example: 25
soft_limit_linesinteger- Controls the max number of lines per subtitle. A warning is shown in the editor if this limit is exceeded. Example: 2
soft_limit_max_durationinteger- Controls max duration of subtitles in milliseconds. This controls the message in the guidelines dialog. Example: 25
soft_limit_min_durationinteger- Controls min duration of subtitles in milliseconds. A warning is shown in the editor if this limit is exceeded. Example: 25
subtitles_completeboolean- Are the subtitles for this language complete? (optional). Example: true
amara_message_sendSend an Amara message to a user or to a whole team.WriteSend Message
Send an Amara message to a user or to a whole team. This notifies the recipients. Users are given as a username or as id$ plus the user ID.
Inputs
contentstringrequired- Content of the message. Example: The Spanish subtitles are due Friday.
subjectstringrequired- Subject of the message. Example: Subtitle deadline
teamstring- Recipient team. Example: my-team
userstring- Recipient user (see Specifying users in request data ). Example: id$jGvdcg-jNoGc32ySWS13tD
amara_project_createCreate a project in a team with a name, slug, description and guidelines.WriteCreate Project
Create a project in a team with a name, slug, description and guidelines. Needs team admin rights.
Inputs
namestringrequired- Project name. Example: Season 1
slugstringrequired- Slug for the project. Example: season-1
team_slugstringrequired- Team Slug. Example: my-team
descriptionstring- Project description. Example: Introduction video
guidelinesstring- Guidelines for users working on the project. Example: Use sentence case.
amara_project_updateUpdate a team project's name, description or guidelines.WriteUpdate Project
Update a team project's name, description or guidelines. Get the project slug from amara_projects_list.
- Idempotent
Inputs
project_slugstringrequired- Project Slug. Example: season-1
team_slugstringrequired- Team Slug. Example: my-team
descriptionstring- Project description. Example: Introduction video
guidelinesstring- Guidelines for users working on the project. Example: Use sentence case.
namestring- Project name. Example: Season 1
amara_subtitle_action_performRun a workflow action (such as publish, approve or reject) on a subtitle language.WritePerform Subtitle Action
Run a workflow action (such as publish, approve or reject) on a subtitle language. Get valid action names from amara_subtitle_actions_list.
Inputs
actionstringrequired- Action to perform. Example: publish
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
amara_subtitle_note_addAdd an editor note to a subtitle language.WriteAdd Subtitle Note
Add an editor note to a subtitle language. Get the video ID from amara_videos_list.
Inputs
bodystringrequired- Note body. Example: Please check the timing at 00:42.
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
amara_subtitle_request_createRequest subtitles for a team video in a language, with due dates, optionally sending the work to another team.WriteCreate Subtitle Request
Request subtitles for a team video in a language, with due dates, optionally sending the work to another team. The video must belong to the team.
Inputs
languagestringrequired- Language code for the subtitles. Example: es
team_slugstringrequired- Team Slug. Example: my-team
videostringrequired- Video ID. This must be part of the team identified in the URL path. Example: NI1hLjBxuTpk
approval_due_datestring- Due date for the approval assignment. Example: 2026-02-14T00:00:00Z
due_datestring- Due date for the request. Example: 2026-02-15T00:00:00Z
evaluation_teamsarray- List of evaluation teams. They can be any team you are an admin of (defaults to the empty list). Example: ["review-team"]
review_due_datestring- Due date for the review assignment. Example: 2026-02-12T00:00:00Z
subtitles_due_datestring- Due date for the subtitling assignment. Example: 2026-02-10T00:00:00Z
teamstring- Work team. This can be any team you are an admin of (defaults to the video's team). Example: my-team
amara_subtitle_request_updateAssign the subtitler, reviewer, approver or evaluator, move the request to another stage, mark it complete or change due dates.WriteUpdate Subtitle Request
Assign the subtitler, reviewer, approver or evaluator, move the request to another stage, mark it complete or change due dates. Get the job ID from amara_subtitle_requests_list. Users are given as a username or as id$ plus the user ID.
- Idempotent
Inputs
job_idstringrequired- Job ID. Example: AbC12dE
team_slugstringrequired- Team Slug. Example: my-team
approval_due_datestring- Due date for the approval assignment. Example: 2026-02-14T00:00:00Z
approverstring- User to assign as the approver, or null to unassign the current approver (see Specifying users in request data ). Example: maria
due_datestring- Due date for the request. Example: 2026-02-15T00:00:00Z
evaluation_due_datestring- Due date for the evaluation assignment. Example: 2026-02-20T00:00:00Z
evaluation_teamsstring- (source team only) Change the evaluation teams. This is only possible if evaluations have not been started. Example: review-team
evaluatorstring- User to assign as the evaluator, or null to unassign the current evaluator (see Specifying users in request data ). Example: maria
review_due_datestring- Due date for the review assignment. Example: 2026-02-12T00:00:00Z
reviewerstring- User to assign as the reviewer, or null to unassign the current reviewer (see Specifying users in request data ). Example: john
subtitlerstring- User to assign as the subtitler, or null to unassign the current subtitler (see Specifying users in request data ). Example: jane
subtitles_due_datestring- Due date for the subtitling assignment. Example: 2026-02-10T00:00:00Z
teamstring- Change the work team. This is only possible if work has not been started. Example: my-team
work_stagestring- Used to change the state of the request. See below for possible values. Example: subtitle
work_statusstring- Deprecated method to change the state of the request. Set to complete to mark the subtitles complete. Example: complete
amara_subtitles_addUpload a new subtitle version for a language, as text or a file URL in a given format, optionally running an action such as publish.WriteAdd Subtitles
Upload a new subtitle version for a language, as text or a file URL in a given format, optionally running an action such as publish. Use amara_subtitle_actions_list to see allowed actions.
Inputs
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
actionstring- Name of the action to perform - optional, but recommended. If given, the is_complete param will be ignored. For more details, see the subtitle actions documentation. Example: publish
descriptionstring- Give a description to the new revision. Example: Introduction video
sub_formatstring- The format used to parse the subs. The same formats as for fetching subtitles are accepted. (Defaults to dfxp ). Example: srt
subtitlesstring- The subtitles to submit, as a string. The format depends on the sub_format param. Example: 1 00:00:00,000 --> 00:00:02,000 Hello world
subtitles_urlstring- Alternatively, subtitles can be given as a text file URL. The format depends on the sub_format param. Example: https://example.com/subs.srt
titlestring- Give a title to the new revision. Example: Meet Amara
amara_team_member_addAdd a user to a team with a role (owner, admin, manager, contributor and so on).WriteAdd Team Member
Add a user to a team with a role (owner, admin, manager, contributor and so on). Needs team admin rights. Users are given as a username or as id$ plus the user ID.
Inputs
rolestringrequired- Possible values: owner , admin , manager , proj_lang_manager , contributor , or limited_contributor (for collaboration teams only). Example: contributor
team_slugstringrequired- Team Slug. Example: my-team
userstringrequired- User to add (see Specifying users in request data ). Example: id$jGvdcg-jNoGc32ySWS13tD
languages_managedarray- (for proj_lang_manager only ) the list of languages managed by the language manager. Example: ["es"]
projects_managedarray- (for proj_lang_manager only ) the list of projects managed by the project manager. Example: ["season-1"]
amara_team_member_updateChange a team member's role and managed languages or projects.WriteChange Team Member Role
Change a team member's role and managed languages or projects. Needs team admin rights.
- Idempotent
Inputs
team_slugstringrequired- Team Slug. Example: my-team
user_identifierstringrequired- User Identifier. Example: id$jGvdcg-jNoGc32ySWS13tD
languages_managedarray- (for proj_lang_manager only ) the list of languages managed by the language manager. Example: ["es"]
projects_managedarray- (for proj_lang_manager only ) the list of projects managed by the project manager. Example: ["season-1"]
rolestring- Possible values: owner , admin , manager , proj_lang_manager , contributor , or limited_contributor (for collaboration teams only). Example: contributor
amara_user_updateUpdate the API key owner's username, email or name.WriteUpdate My Account
Update the API key owner's username, email or name. Only your own account can be updated.
- Idempotent
Inputs
identifierstringrequired- Identifier. Example: id$jGvdcg-jNoGc32ySWS13tD
emailstring- A valid email address. Example: jane@example.com
first_namestring- Any chars, max 30 chars. Example: Jane
last_namestring- Any chars, max 30 chars. Example: Doe
usernamestring- 30 chars or fewer alphanumeric chars, @, _ and are accepted. Example: jane_doe
amara_video_createAdd a video to Amara from a YouTube, Vimeo or direct media URL, optionally into a team and project, with title, description, language and metadata.WriteAdd Video
Add a video to Amara from a YouTube, Vimeo or direct media URL, optionally into a team and project, with title, description, language and metadata. Use amara_language_create and amara_subtitles_add to subtitle it.
Inputs
video_urlstringrequired- The url for the video. Any url that Amara accepts will work here. You can send the URL for a file (e.g. http:///www.example.com/my-video.ogv), or a link to one of our accepted providers (YouTube, Vimeo). Example: https://www.youtube.com/watch?v=aQ-xe-GSjdA
descriptionstring- About this video. Example: Introduction video
durationinteger- Duration in seconds, in case it can not be retrieved automatically by Amara. Example: 120
metadataobject- Dictionary of metadata key/value pairs. These handle extra information about the video. Right now the type keys supported are speaker-name and location. Values can be any string. Example: {"speaker-name": "Jane Doe"}
primary_audio_language_codestring- language code for the main language spoken in the video. Example: en
projectstring- Project slug for the video or null to put it in the default project. Example: season-1
teamstring- Team slug for the video or null to remove it from its team. Example: my-team
thumbnailstring- URL to the video thumbnail. Example: https://example.com/thumb.jpg
titlestring- Title of the video. Example: Meet Amara
amara_project_deleteDelete a team project.DestructiveDelete Project
Delete a team project. Its videos move to the default project. Get the project slug from amara_projects_list.
- Idempotent
Inputs
project_slugstringrequired- Project Slug. Example: season-1
team_slugstringrequired- Team Slug. Example: my-team
amara_subtitle_request_deleteDelete a subtitle request.DestructiveDelete Subtitle Request
Delete a subtitle request. Get the job ID from amara_subtitle_requests_list.
- Idempotent
Inputs
job_idstringrequired- Job ID. Example: AbC12dE
team_slugstringrequired- Team Slug. Example: my-team
amara_subtitles_deleteDelete all subtitle versions for a language.DestructiveDelete Subtitles
Delete all subtitle versions for a language. This cannot be undone. Get the video ID from amara_videos_list.
- Idempotent
Inputs
language_codestringrequired- Language Code. Example: en
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
amara_team_member_removeRemove a user from a team.DestructiveRemove Team Member
Remove a user from a team. Needs team admin rights.
- Idempotent
Inputs
team_slugstringrequired- Team Slug. Example: my-team
user_identifierstringrequired- User Identifier. Example: id$jGvdcg-jNoGc32ySWS13tD
amara_video_deleteDelete a video from Amara (only for team videos you can manage).DestructiveDelete Video
Delete a video from Amara (only for team videos you can manage). Get the video ID from amara_videos_list.
- Idempotent
Inputs
video_idstringrequired- Video ID. Example: NI1hLjBxuTpk
No tools match.