Skip to main content
Amara logo
  • Category: video & audio
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: AMARA
  • Version: 20261101_00

Tools

Slug: AMARA_ADD_SUBTITLE_NOTEAdds a note/comment to a specific subtitle language for a video. Notes are used for collaboration and providing feedback on subtitles during the editing process. Requires a valid video ID and language code. Use this tool to document issues, provide suggestions, or communicate with other subtitle editors.

Input Parameters

string
required
The text content of the note. Supports multi-line text, special characters, and Unicode. Use this to provide feedback, suggestions, or document issues with the subtitles.
string
required
The unique Amara video identifier. Can be obtained from list videos or view video details actions.
string
required
BCP-47 language code for the subtitle language (e.g., ‘en’ for English, ‘es’ for Spanish, ‘fr’ for French). Must correspond to an existing subtitle language for the video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_ADD_VIDEO_URLTool to add a new URL to a video, allowing association with multiple video providers (YouTube, Vimeo, etc.). Use when you need to add alternative URLs for the same video content on different platforms.

Input Parameters

string
required
The video URL to add (e.g., YouTube, Vimeo, Dailymotion URLs).
boolean
Set to true to mark this URL as the primary URL for the video.
string
required
The Amara video identifier (e.g., ‘GniXaI2Sc5zw’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_CREATE_SUBTITLE_LANGUAGECreates a new subtitle language track for an Amara video. This is the first step before adding or uploading subtitles - you must create the language track before you can add subtitle content. Each video can have multiple subtitle languages, but you cannot create the same language twice for the same video. Use list_subtitle_languages to check existing languages before creating a new one.

Input Parameters

string
required
ISO 639-1 two-letter language code for the subtitle language (e.g., ‘en’ for English, ‘fr’ for French, ‘es’ for Spanish, ‘ja’ for Japanese).
string
required
The Amara video ID to add the subtitle language to. Obtain this from list_videos or view_video_details actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_CREATE_SUBTITLESTool to create new subtitles for a video in a specific language. Accepts subtitle data in multiple formats (SRT, VTT, DFXP, etc.) either as a string or via URL. The subtitle language must already exist for the video - use create_subtitle_language first if needed. Use when you need to add subtitle content to a video.

Input Parameters

string
Optional title or description for this subtitle version.
string
Optional action type for the subtitle creation.
object
Optional metadata object to attach to the subtitles.
string
required
The Amara video ID to add subtitles to. Obtain this from list_videos or view_video_details actions.
string
Subtitle content as a string in the format specified by sub_format. For SRT format, use the standard format with numbering, timestamps, and text. Provide either this field or subtitles_url, but not both.
string ("json" | "srt" | "dfxp" | "vtt" | "sbv" | "txt" | "ssa")
required
The format of the subtitle data being provided. Must match the format of the data in subtitles or at subtitles_url.
string
Optional description for this subtitle version.
string
required
ISO 639-1 two-letter language code for the subtitle language (e.g., ‘en’ for English, ‘de’ for German, ‘fr’ for French). The language must already exist for this video - use create_subtitle_language first if needed.
string
URL to a subtitle file to import. Provide either this field or subtitles, but not both. The file at the URL must be accessible and in the format specified by sub_format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_CREATE_VIDEOTool to add a new video to Amara. Use when you need to create a video entry from a URL. Supports URLs from YouTube, Vimeo, Dailymotion, or direct video file URLs.

Input Parameters

string
Team slug to assign the video to. The video will belong to this team if specified.
string
required
Title of the video.
string
Project slug to assign the video to. The video will belong to this project if specified.
integer
Duration of the video in seconds. If not provided, Amara will attempt to detect it automatically.
object
Dictionary of additional metadata key-value pairs (e.g., ‘speaker-name’, ‘location’). Use this to store custom information about the video. All keys and values must be strings.
string
URL to a custom thumbnail image for the video. If not provided, Amara will use a default or extract one from the video.
string
required
The URL for the video. Supports YouTube, Vimeo, Dailymotion URLs, or direct video file URLs (e.g., ‘https://vimeo.com/123456789’ or ‘https://example.com/video.mp4’).
string
Description about this video. Provides context about the video content.
string
ISO 639-1 two-letter language code for the main language spoken in the video (e.g., ‘en’ for English, ‘fr’ for French).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_DELETE_VIDEO_URLTool to remove a video URL from a video. Use when you need to delete an unwanted or incorrect URL from a video’s list of URLs. The video must have at least one other URL remaining.

Input Parameters

integer
required
The internal ID of the video URL resource to delete.
string
required
The Amara video identifier (e.g., ‘GniXaI2Sc5zw’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_FETCH_SUBTITLES_DATAFetch subtitle data for an Amara video in a specified language, returning text segments with start and end timestamps. Use a video ID and an available subtitle language code. JSON is the default; SRT and VTT downloads are not available through this tool.

Input Parameters

string ("json" | "srt" | "vtt")
Subtitle format to retrieve. Defaults to ‘json’ when omitted.
string
required
Amara video ID.
string
required
BCP-47 code for the subtitle language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_GET_ACTIVITYTool to retrieve detailed information about a specific activity by its ID. Use when you need to fetch metadata for a particular activity event.

Input Parameters

integer
required
Unique identifier for the activity to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_GET_SUBTITLE_LANGUAGE_DETAILSTool to retrieve details for a single subtitle language. Use when you have video ID and language code and need metadata about that language track.

Input Parameters

string
required
Amara video ID.
string
required
BCP-47 code for the subtitle language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_GET_TEAM_DETAILSTool to get details on a specific team by slug. Use when you need metadata for a single team.

Input Parameters

string
required
Machine name (slug) of the team to retrieve details for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_GET_TEAM_LANGUAGESRetrieves preferred and blacklisted language lists for a team by slug. A list may be empty if its linked resource is unavailable or cannot be parsed as a list.

Input Parameters

string
required
Machine name (slug) of the team to retrieve language preferences for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_GET_USER_ACTIVITYTool to retrieve activity log for a specific user on Amara. Use when you need to view a user’s recent actions such as video additions, subtitle edits, or comments. Returns a paginated list of activity items with details about what actions the user performed, on which videos, and in which languages.

Input Parameters

integer
Maximum number of activity items to return.
integer
Number of activity items to skip for pagination.
string
required
User identifier - can be a username (e.g., ‘Composio’), ‘me’ for authenticated user, or user ID with ‘id$’ prefix (e.g., ‘id$abc123’). Note: User IDs are more reliable than usernames since usernames can change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_GET_USER_DATARetrieves detailed user profile information from Amara, including username, avatar, biography, languages spoken, and video counts. Use this tool when you need to: - Fetch a user’s profile details by their username or user ID - Get information about the authenticated user using ‘me’ as identifier - Look up user metadata like languages, biography, or avatar - Obtain user resource URIs for further API operations Note: User IDs (with ‘id$’ prefix) are more reliable than usernames since usernames can be changed by users.

Input Parameters

string
required
User identifier - can be a username (e.g., ‘bendk’), ‘me’ for authenticated user, or user ID with ‘id$’ prefix (e.g., ‘id$abc123’). Note: User IDs are more reliable than usernames since usernames can change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_GET_VIDEO_URLTool to get details for a specific video URL. Use when you need to retrieve metadata about a specific URL entry in Amara’s system by video_id and url_id.

Input Parameters

integer
required
URL identifier for the specific video URL to retrieve
string
required
Amara video identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_GET_VIDEO_URL_DETAILSLooks up an Amara video by public or embeddable video URL and returns metadata for the first matching video, including its ID, title, duration and thumbnail. It derives an embed URL for supported platforms when possible.

Input Parameters

string
required
A public or embeddable video URL to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_ACTIVITYList a page of Amara activity with optional filters including team, video and activity type. If both team and video are supplied, the team filter takes precedence and video is ignored.

Input Parameters

string
Filter by team slug to show only items related to a given team. If both team and video are provided, team takes precedence and video is ignored.
integer
Filter by activity type. Valid values are 1-15 corresponding to different actions: 1=Add video, 2=Change title, 3=Comment, 4=Add version, 5=Add video URL, 6=Add translation, 7=Subtitle request, 8=Approve version, 9=Member joined, 10=Reject version, 11=Member left, 12=Review version, 13=Accept version, 14=Decline version, 15=Delete video.
string
Only include activity items after this timestamp (ISO 8601 format).
integer
Maximum number of activity items to return per page. Defaults to 20 if not specified.
string
Filter by video ID to show only items related to a given video. Ignored if team parameter is also provided.
string
Only include activity items before this timestamp (ISO 8601 format).
integer
Number of activity items to skip before starting to return results. Used for pagination. Defaults to 0.
string
Filter by language code (BCP-47) to show only items with a given language code.
boolean
If team is given, normally returns activity on the team’s videos. Set to true to see activity for the team itself (members joining/leaving and team video deletions). Only applies when team parameter is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_AVAILABLE_LANGUAGESTool to get a list of all supported languages. Use when you need to know available language options from Amara.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_SUBTITLE_ACTIONSTool to list available actions for subtitles based on current workflow state. Use when you need to determine what operations can be performed on a subtitle (e.g., approve, reject, publish) for a specific video and language.

Input Parameters

string
required
Amara video ID for which to list available subtitle actions.
string
required
BCP-47 code for the subtitle language (e.g., ‘en’ for English, ‘pt-BR’ for Brazilian Portuguese).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_SUBTITLE_LANGUAGESList a page of subtitle languages for a video by video ID. The response includes pagination information.

Input Parameters

string
required
Amara video ID for which to list subtitle languages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_SUBTITLE_NOTESList a page of notes for a video’s subtitle language, with pagination controls and response metadata.

Input Parameters

integer
Maximum number of notes to return per page. Defaults to 20 if not specified.
integer
Number of notes to skip before starting to return results. Used for pagination. Defaults to 0.
string
required
The unique Amara video identifier. Can be obtained from list videos or view video details actions.
string
required
BCP-47 language code for the subtitle language (e.g., ‘en’ for English, ‘es’ for Spanish, ‘fr’ for French). Must correspond to an existing subtitle language for the video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_TEAMSTool to list all teams. Use when you need to retrieve your accessible teams with pagination.

Input Parameters

integer
Maximum number of teams to return.
integer
Results offset for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_VIDEO_ACTIVITYTool to list activity for a specific video. Use when you need to fetch the activity log or history of actions performed on a video.

Input Parameters

integer
Maximum number of activity records to return per page. Defaults to 20 if not specified.
integer
Number of activity records to skip before starting to return results. Used for pagination. Defaults to 0.
string
required
Amara video identifier to get activity for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_VIDEOSLists videos in paginated results with optional filters. Without query parameters, Amara lists the last 20 public videos.

Input Parameters

string
Sorting order, e.g., ‘-created’ or ‘-primary_audio_language_code’.
string
Filter by team slug.
integer
Maximum number of videos to return per page. Defaults to 20 if not specified.
string
Filter by owner username.
integer
Number of videos to skip before starting to return results. Used for pagination. Defaults to 0.
boolean
If true, only archived videos are returned.
string
Filter by project slug.
string
Filter by language code (BCP-47), e.g., ‘en’.
string
Comma-separated list of video IDs to filter.
string
Filter by exact video URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_LIST_VIDEO_URLSLists URLs associated with a video, with pagination for retrieving additional pages. Use to find video URLs for embedding or processing.

Input Parameters

integer
Maximum number of URLs to return.
integer
Index of the first URL to return (0-indexed).
string
required
Amara video ID for which to list all associated video URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_MAKE_VIDEO_URL_PRIMARYTool to set a video URL as the primary URL. Use when you need to designate one of a video’s URLs as primary for embedding and display. Call after listing video URLs to confirm the URL ID.

Input Parameters

integer
required
The internal ID of the video URL resource to mark as primary.
boolean
required
Set to true to mark this URL as the primary URL.
string
required
The Amara video identifier (e.g., ‘NI1hLjBxuTpk’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_PERFORM_SUBTITLE_ACTIONTool to perform an action on subtitles such as publish, unpublish, approve, reject, send-back, or endorse. Use when you need to change the workflow state of subtitles for a specific video and language. The available actions depend on the current workflow state and team settings.

Input Parameters

string
required
Action to perform on the subtitles. Common actions include ‘publish’ (make subtitles public), ‘unpublish’ (make subtitles private), ‘approve’ (approve subtitles in workflow), ‘reject’ (reject subtitles), ‘send-back’ (send back for revision), ‘endorse’ (endorse and move to next stage), ‘save-draft’ (save as draft). The available actions depend on the video’s workflow state and team settings. Use list_subtitle_actions to discover available actions for a specific video and language.
string
required
Amara video ID for which to perform the subtitle action.
string
required
ISO 639-1 two-letter language code for the subtitle language (e.g., ‘en’ for English, ‘de’ for German).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_SEND_MESSAGESends a message to a user or team member in Amara. Use this tool to send notifications, updates, or communicate with other users or teams on the platform. You must specify either a recipient user (by username or user ID) or a team (by team slug), but not both.

Input Parameters

string
Team slug to send the message to. Either ‘user’ or ‘team’ must be provided, but not both. Example: ‘my-team-slug’.
string
Username or user ID (with ‘id$’ prefix) to send the message to. Either ‘user’ or ‘team’ must be provided, but not both. Example: ‘bendk’ or ‘id$abc123’.
string
required
Message body text. Required field. Supports multi-line text and Unicode characters.
string
required
Subject line for the message. Required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_UPDATE_SUBTITLE_LANGUAGETool to update a subtitle language for a video. Use after reviewing existing subtitle language settings and needing to adjust completeness flags or soft-limit constraints.

Input Parameters

string
required
Amara video ID.
string
required
BCP-47 code for the subtitle language.
integer
Maximum characters per line; warning shown if exceeded.
integer
Maximum characters per second; warning shown if exceeded.
integer
Maximum number of lines per subtitle; warning shown if exceeded.
boolean
Indicates if the subtitles are complete for this language.
integer
Maximum subtitle duration in milliseconds; used in guidelines dialog.
integer
Minimum subtitle duration in milliseconds; warning shown if violated.
boolean
Indicates if this is the primary spoken language of the video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_UPDATE_VIDEOTool to update an existing video’s metadata including title, description, team, and project assignment. Use when you need to modify video information after creation.

Input Parameters

string
Slug of the team the video belongs to
string
Video title
string
Slug of the project the video belongs to
integer
Video duration in seconds
object
Metadata key/value pairs for the video
string
required
Amara video identifier
string
URL to the video thumbnail
string
Video description
string
Language code for the main audio track (BCP-47)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMARA_VIEW_VIDEO_DETAILSTool to view details of a specific video by ID. Use when you need complete metadata for a given video.

Input Parameters

string
required
Amara video identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not