API - Corsair

Every amara.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Activity

get

activity.get Get a single activity item by id Risk: read

await corsair.amara.api.activity.get({});

Input

Name	Type	Required	Description
`activity_id`	`string \| number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number \| string`	No	—
`type`	`number \| string`	No	—
`type_name`	`string`	No	—
`created`	`string`	No	—
`video`	`string`	No	—
`video_uri`	`string`	No	—
`language`	`string`	No	—
`language_url`	`string`	No	—
`user`	`object`	No	—
`comment`	`string`	No	—
`new_video_title`	`string`	No	—
`resource_uri`	`string`	No	—

user full type

{
  id?: string,
  username?: string,
  uri?: string
} | string

list

activity.list List platform activity with optional filters Risk: read

await corsair.amara.api.activity.list({});

Input

Name	Type	Required	Description
`team`	`string`	No	—
`type`	`string \| number`	No	—
`after`	`string`	No	—
`limit`	`number`	No	Page size
`video`	`string`	No	—
`before`	`string`	No	—
`offset`	`number`	No	Result offset
`language`	`string`	No	—
`team_activity`	`string \| boolean`	No	—

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  id?: number | string,
  type?: number | string,
  type_name?: string,
  created?: string | null,
  video?: string | null,
  video_uri?: string | null,
  language?: string | null,
  language_url?: string | null,
  user?: {
    id?: string,
    username?: string,
    uri?: string
  } | string | null,
  comment?: string | null,
  new_video_title?: string | null,
  resource_uri?: string
}[]

Languages

listAvailable

languages.listAvailable List all supported Amara language codes Risk: read

await corsair.amara.api.languages.listAvailable({});

Input: empty object Output

Name	Type	Required	Description
`languages`	`object`	Yes	—

languages full type

{
}

Messages

send

messages.send Send a message to a user or team Risk: write

await corsair.amara.api.messages.send({});

Input

Name	Type	Required	Description
`subject`	`string`	Yes	—
`content`	`string`	Yes	—
`user`	`string`	No	—
`team`	`string`	No	—

Output: empty object

Teams

addMember

teams.addMember Add a new member to a team Risk: write

await corsair.amara.api.teams.addMember({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`user`	`string`	Yes	—
`role`	`owner \| admin \| manager \| contributor \| proj_lang_manager \| limited_contributor`	No	—

Output

Name	Type	Required	Description
`user`	`object`	No	—
`role`	`string`	No	—
`languages_managed`	`string[]`	No	—
`resource_uri`	`string`	No	—

user full type

{
  username?: string | null,
  id?: string,
  full_name?: string | null,
  first_name?: string | null,
  last_name?: string | null,
  biography?: string | null,
  homepage?: string | null,
  avatar?: string | null,
  languages?: string[],
  num_videos?: number,
  resource_uri?: string,
  created_by?: string | null,
  is_partner?: boolean,
  activity_uri?: string
} | string

createProject

teams.createProject Create a new project in a team Risk: write

await corsair.amara.api.teams.createProject({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`name`	`string`	Yes	—
`slug`	`string`	Yes	—
`description`	`string`	No	—
`guidelines`	`string`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`slug`	`string`	No	—
`description`	`string`	No	—
`guidelines`	`string`	No	—
`created`	`string`	No	—
`modified`	`string`	No	—
`workflow_enabled`	`boolean`	No	—
`resource_uri`	`string`	No	—

deleteProject

teams.deleteProject Delete a project from a team Risk: write

await corsair.amara.api.teams.deleteProject({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`project_slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`ok`	`true`	No	—

getDetails

teams.getDetails Get team details by slug Risk: read

await corsair.amara.api.teams.getDetails({});

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`slug`	`string`	No	—
`type`	`string`	No	—
`description`	`string`	No	—
`team_visibility`	`string`	No	—
`video_visibility`	`string`	No	—
`is_visible`	`boolean`	No	—
`membership_policy`	`string`	No	—
`video_policy`	`string`	No	—
`activity_uri`	`string`	No	—
`members_uri`	`string`	No	—
`projects_uri`	`string`	No	—
`applications_uri`	`string`	No	—
`languages_uri`	`string`	No	—
`tasks_uri`	`string`	No	—
`resource_uri`	`string`	No	—

getLanguages

teams.getLanguages Get preferred/blacklisted language URIs for a team Risk: read

await corsair.amara.api.teams.getLanguages({});

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`preferred`	`string`	No	—
`blacklisted`	`string`	No	—

getMember

teams.getMember Get details for a specific team member Risk: read

await corsair.amara.api.teams.getMember({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`username`	`string`	Yes	—

Output

Name	Type	Required	Description
`user`	`object`	No	—
`role`	`string`	No	—
`languages_managed`	`string[]`	No	—
`resource_uri`	`string`	No	—

user full type

{
  username?: string | null,
  id?: string,
  full_name?: string | null,
  first_name?: string | null,
  last_name?: string | null,
  biography?: string | null,
  homepage?: string | null,
  avatar?: string | null,
  languages?: string[],
  num_videos?: number,
  resource_uri?: string,
  created_by?: string | null,
  is_partner?: boolean,
  activity_uri?: string
} | string

getProject

teams.getProject Get details for a specific team project Risk: read

await corsair.amara.api.teams.getProject({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`project_slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`slug`	`string`	No	—
`description`	`string`	No	—
`guidelines`	`string`	No	—
`created`	`string`	No	—
`modified`	`string`	No	—
`workflow_enabled`	`boolean`	No	—
`resource_uri`	`string`	No	—

getTask

teams.getTask Get details for a specific team task Risk: read

await corsair.amara.api.teams.getTask({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`task_id`	`string \| number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number \| string`	No	—
`video_id`	`string`	No	—
`language`	`string`	No	—
`type`	`string`	No	—
`priority`	`number`	No	—
`assignee`	`object`	No	—
`completed`	`string \| boolean`	No	—
`created`	`string`	No	—
`modified`	`string`	No	—
`resource_uri`	`string`	No	—

assignee full type

{
  username?: string | null,
  id?: string,
  full_name?: string | null,
  first_name?: string | null,
  last_name?: string | null,
  biography?: string | null,
  homepage?: string | null,
  avatar?: string | null,
  languages?: string[],
  num_videos?: number,
  resource_uri?: string,
  created_by?: string | null,
  is_partner?: boolean,
  activity_uri?: string
} | string

list

teams.list List teams Risk: read

await corsair.amara.api.teams.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  name?: string,
  slug?: string,
  type?: string | null,
  description?: string | null,
  team_visibility?: string | null,
  video_visibility?: string | null,
  is_visible?: boolean,
  membership_policy?: string | null,
  video_policy?: string | null,
  activity_uri?: string,
  members_uri?: string,
  projects_uri?: string,
  applications_uri?: string | null,
  languages_uri?: string | null,
  tasks_uri?: string | null,
  resource_uri?: string
}[]

listApplications

teams.listApplications List membership applications for a team Risk: read

await corsair.amara.api.teams.listApplications({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`status`	`string`	No	—
`user`	`string`	No	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  id?: number | string,
  user?: {
    username?: string | null,
    id?: string,
    full_name?: string | null,
    first_name?: string | null,
    last_name?: string | null,
    biography?: string | null,
    homepage?: string | null,
    avatar?: string | null,
    languages?: string[],
    num_videos?: number,
    resource_uri?: string,
    created_by?: string | null,
    is_partner?: boolean,
    activity_uri?: string
  } | string,
  status?: string,
  created?: string | null,
  message?: string | null,
  resource_uri?: string
}[]

listMembers

teams.listMembers List members of a team Risk: read

await corsair.amara.api.teams.listMembers({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  user?: {
    username?: string | null,
    id?: string,
    full_name?: string | null,
    first_name?: string | null,
    last_name?: string | null,
    biography?: string | null,
    homepage?: string | null,
    avatar?: string | null,
    languages?: string[],
    num_videos?: number,
    resource_uri?: string,
    created_by?: string | null,
    is_partner?: boolean,
    activity_uri?: string
  } | string,
  role?: string,
  languages_managed?: string[],
  resource_uri?: string
}[]

listProjects

teams.listProjects List projects within a team Risk: read

await corsair.amara.api.teams.listProjects({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  name?: string,
  slug?: string,
  description?: string | null,
  guidelines?: string | null,
  created?: string | null,
  modified?: string | null,
  workflow_enabled?: boolean,
  resource_uri?: string
}[]

listTasks

teams.listTasks List tasks within a team with optional filters Risk: read

await corsair.amara.api.teams.listTasks({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`assignee`	`string`	No	—
`priority`	`number`	No	—
`type`	`string`	No	—
`video_id`	`string`	No	—
`completed`	`string \| boolean`	No	—
`open`	`string \| boolean`	No	—
`order_by`	`string`	No	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  id?: number | string,
  video_id?: string,
  language?: string,
  type?: string,
  priority?: number,
  assignee?: {
    username?: string | null,
    id?: string,
    full_name?: string | null,
    first_name?: string | null,
    last_name?: string | null,
    biography?: string | null,
    homepage?: string | null,
    avatar?: string | null,
    languages?: string[],
    num_videos?: number,
    resource_uri?: string,
    created_by?: string | null,
    is_partner?: boolean,
    activity_uri?: string
  } | string | null,
  completed?: string | boolean | null,
  created?: string | null,
  modified?: string | null,
  resource_uri?: string
}[]

removeMember

teams.removeMember Remove a member from a team Risk: write

await corsair.amara.api.teams.removeMember({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`username`	`string`	Yes	—

Output

Name	Type	Required	Description
`ok`	`true`	No	—

updateMember

teams.updateMember Update member role in a team Risk: write

await corsair.amara.api.teams.updateMember({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`username`	`string`	Yes	—
`role`	`owner \| admin \| manager \| contributor \| proj_lang_manager \| limited_contributor`	Yes	—

Output

Name	Type	Required	Description
`user`	`object`	No	—
`role`	`string`	No	—
`languages_managed`	`string[]`	No	—
`resource_uri`	`string`	No	—

user full type

{
  username?: string | null,
  id?: string,
  full_name?: string | null,
  first_name?: string | null,
  last_name?: string | null,
  biography?: string | null,
  homepage?: string | null,
  avatar?: string | null,
  languages?: string[],
  num_videos?: number,
  resource_uri?: string,
  created_by?: string | null,
  is_partner?: boolean,
  activity_uri?: string
} | string

updateProject

teams.updateProject Update a team project Risk: write

await corsair.amara.api.teams.updateProject({});

Input

Name	Type	Required	Description
`team_slug`	`string`	Yes	—
`project_slug`	`string`	Yes	—
`name`	`string`	No	—
`description`	`string`	No	—
`guidelines`	`string`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`slug`	`string`	No	—
`description`	`string`	No	—
`guidelines`	`string`	No	—
`created`	`string`	No	—
`modified`	`string`	No	—
`workflow_enabled`	`boolean`	No	—
`resource_uri`	`string`	No	—

Users

getActivity

users.getActivity List activity for a user Risk: read

await corsair.amara.api.users.getActivity({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  id?: number | string,
  type?: number | string,
  type_name?: string,
  created?: string | null,
  video?: string | null,
  video_uri?: string | null,
  language?: string | null,
  language_url?: string | null,
  user?: {
    id?: string,
    username?: string,
    uri?: string
  } | string | null,
  comment?: string | null,
  new_video_title?: string | null,
  resource_uri?: string
}[]

getData

users.getData Get a user profile by identifier (or “me”) Risk: read

await corsair.amara.api.users.getData({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	Username, id$…, or “me”

Output

Name	Type	Required	Description
`username`	`string`	No	—
`id`	`string`	No	—
`full_name`	`string`	No	—
`first_name`	`string`	No	—
`last_name`	`string`	No	—
`biography`	`string`	No	—
`homepage`	`string`	No	—
`avatar`	`string`	No	—
`languages`	`string[]`	No	—
`num_videos`	`number`	No	—
`resource_uri`	`string`	No	—
`created_by`	`string`	No	—
`is_partner`	`boolean`	No	—
`activity_uri`	`string`	No	—

Videos

addSubtitleNote

videos.addSubtitleNote Add an editor note to a subtitle set Risk: write

await corsair.amara.api.videos.addSubtitleNote({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—
`body`	`string`	Yes	—

Output

Name	Type	Required	Description
`body`	`string`	No	—
`created`	`string`	No	—
`user`	`object`	No	—

user full type

{
  id?: string,
  username?: string,
  uri?: string
}

addUrl

videos.addUrl Add a URL to a video Risk: write

await corsair.amara.api.videos.addUrl({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`url`	`string`	Yes	—
`primary`	`boolean`	No	—

Output

Name	Type	Required	Description
`created`	`string`	No	—
`url`	`string`	No	—
`primary`	`boolean`	No	—
`original`	`boolean`	No	—
`id`	`number`	No	—
`resource_uri`	`string`	No	—
`videoid`	`string`	No	—
`type`	`string`	No	—

create

videos.create Create a video from a public URL Risk: write

await corsair.amara.api.videos.create({});

Input

Name	Type	Required	Description
`video_url`	`string`	Yes	—
`title`	`string`	Yes	—
`team`	`string`	No	—
`project`	`string`	No	—
`duration`	`number`	No	—
`metadata`	`object`	No	—
`thumbnail`	`string`	No	—
`description`	`string`	No	—
`primary_audio_language_code`	`string`	No	—

metadata full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`video_type`	`string`	No	—
`primary_audio_language_code`	`string`	No	—
`title`	`string`	No	—
`description`	`string`	No	—
`duration`	`number`	No	—
`thumbnail`	`string`	No	—
`created`	`string`	No	—
`team`	`string`	No	—
`project`	`string`	No	—
`all_urls`	`string[]`	No	—
`metadata`	`object`	No	—
`languages`	`object[]`	No	—
`activity_uri`	`string`	No	—
`urls_uri`	`string`	No	—
`subtitle_languages_uri`	`string`	No	—
`resource_uri`	`string`	No	—

metadata full type

{
}

languages full type

{
  code?: string,
  name?: string,
  published?: boolean,
  dir?: string | null,
  subtitles_uri?: string,
  resource_uri?: string
}[]

createSubtitleLanguage

videos.createSubtitleLanguage Create a subtitle language on a video Risk: write

await corsair.amara.api.videos.createSubtitleLanguage({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—
`is_primary_audio_language`	`boolean`	No	—
`soft_limit_cpl`	`number`	No	—
`soft_limit_cps`	`number`	No	—
`soft_limit_lines`	`number`	No	—
`soft_limit_max_duration`	`number`	No	—
`soft_limit_min_duration`	`number`	No	—
`subtitles_complete`	`boolean`	No	—

Output

Name	Type	Required	Description
`created`	`string`	No	—
`language_code`	`string`	No	—
`is_primary_audio_language`	`boolean`	No	—
`is_rtl`	`boolean`	No	—
`soft_limit_cpl`	`number`	No	—
`soft_limit_cps`	`number`	No	—
`soft_limit_lines`	`number`	No	—
`soft_limit_max_duration`	`number`	No	—
`soft_limit_min_duration`	`number`	No	—
`published`	`boolean`	No	—
`name`	`string`	No	—
`title`	`string`	No	—
`description`	`string`	No	—
`metadata`	`object`	No	—
`subtitle_count`	`number`	No	—
`subtitles_complete`	`boolean`	No	—
`versions`	`object[]`	No	—
`subtitles_uri`	`string`	No	—
`resource_uri`	`string`	No	—

metadata full type

{
}

versions full type

{
  author?: {
    id?: string,
    username?: string,
    uri?: string
  } | null,
  published?: boolean,
  version_number?: number,
  created?: string | null
}[]

createSubtitles

videos.createSubtitles Create or update subtitles for a language Risk: write

await corsair.amara.api.videos.createSubtitles({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—
`title`	`string`	No	—
`action`	`string`	No	—
`metadata`	`object`	No	—
`subtitles`	`string \| any[]`	No	—
`sub_format`	`string`	No	—
`description`	`string`	No	—
`subtitles_url`	`string`	No	—

metadata full type

{
}

Output

Name	Type	Required	Description
`version_number`	`number`	No	—
`sub_format`	`string`	No	—
`subtitles`	`object`	No	—
`author`	`object`	No	—
`created`	`string`	No	—
`description`	`string`	No	—
`language`	`object`	No	—
`metadata`	`object`	No	—
`notes_uri`	`string`	No	—
`resource_uri`	`string`	No	—
`site_uri`	`string`	No	—
`title`	`string`	No	—
`video_description`	`string`	No	—
`video_title`	`string`	No	—
`actions_uri`	`string`	No	—

subtitles full type

{
  start?: number,
  end?: number,
  text?: string,
  meta?: {
  },
  position?: number
}[] | string

author full type

{
  id?: string,
  username?: string,
  uri?: string
}

language full type

{
  code?: string,
  dir?: string | null,
  name?: string
}

metadata full type

{
}

deleteUrl

videos.deleteUrl Delete a video URL Risk: write

await corsair.amara.api.videos.deleteUrl({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`url_id`	`string \| number`	Yes	—

Output

Name	Type	Required	Description
`ok`	`true`	No	—

fetchSubtitlesData

videos.fetchSubtitlesData Fetch subtitles for a video language Risk: read

await corsair.amara.api.videos.fetchSubtitlesData({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—
`format`	`string`	No	Subtitle format (default json)
`sub_format`	`string`	No	Alias for format

Output

Name	Type	Required	Description
`version_number`	`number`	No	—
`sub_format`	`string`	No	—
`subtitles`	`object`	No	—
`author`	`object`	No	—
`created`	`string`	No	—
`description`	`string`	No	—
`language`	`object`	No	—
`metadata`	`object`	No	—
`notes_uri`	`string`	No	—
`resource_uri`	`string`	No	—
`site_uri`	`string`	No	—
`title`	`string`	No	—
`video_description`	`string`	No	—
`video_title`	`string`	No	—
`actions_uri`	`string`	No	—

subtitles full type

{
  start?: number,
  end?: number,
  text?: string,
  meta?: {
  },
  position?: number
}[] | string

author full type

{
  id?: string,
  username?: string,
  uri?: string
}

language full type

{
  code?: string,
  dir?: string | null,
  name?: string
}

metadata full type

{
}

getSubtitleLanguageDetails

videos.getSubtitleLanguageDetails Get details for a subtitle language Risk: read

await corsair.amara.api.videos.getSubtitleLanguageDetails({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—

Output

Name	Type	Required	Description
`created`	`string`	No	—
`language_code`	`string`	No	—
`is_primary_audio_language`	`boolean`	No	—
`is_rtl`	`boolean`	No	—
`soft_limit_cpl`	`number`	No	—
`soft_limit_cps`	`number`	No	—
`soft_limit_lines`	`number`	No	—
`soft_limit_max_duration`	`number`	No	—
`soft_limit_min_duration`	`number`	No	—
`published`	`boolean`	No	—
`name`	`string`	No	—
`title`	`string`	No	—
`description`	`string`	No	—
`metadata`	`object`	No	—
`subtitle_count`	`number`	No	—
`subtitles_complete`	`boolean`	No	—
`versions`	`object[]`	No	—
`subtitles_uri`	`string`	No	—
`resource_uri`	`string`	No	—

metadata full type

{
}

versions full type

{
  author?: {
    id?: string,
    username?: string,
    uri?: string
  } | null,
  published?: boolean,
  version_number?: number,
  created?: string | null
}[]

getUrl

videos.getUrl Get a single video URL by id Risk: read

await corsair.amara.api.videos.getUrl({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`url_id`	`string \| number`	Yes	—

Output

Name	Type	Required	Description
`created`	`string`	No	—
`url`	`string`	No	—
`primary`	`boolean`	No	—
`original`	`boolean`	No	—
`id`	`number`	No	—
`resource_uri`	`string`	No	—
`videoid`	`string`	No	—
`type`	`string`	No	—

getUrlDetails

videos.getUrlDetails Look up a video by its public URL Risk: read

await corsair.amara.api.videos.getUrlDetails({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	Public video URL to look up

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  id: string,
  video_type?: string | null,
  primary_audio_language_code?: string | null,
  title?: string | null,
  description?: string | null,
  duration?: number | null,
  thumbnail?: string | null,
  created?: string | null,
  team?: string | null,
  project?: string | null,
  all_urls?: string[],
  metadata?: {
  },
  languages?: {
    code?: string,
    name?: string,
    published?: boolean,
    dir?: string | null,
    subtitles_uri?: string,
    resource_uri?: string
  }[],
  activity_uri?: string,
  urls_uri?: string,
  subtitle_languages_uri?: string,
  resource_uri?: string
}[]

list

videos.list List videos with optional filters and pagination Risk: read

await corsair.amara.api.videos.list({});

Input

Name	Type	Required	Description
`sort`	`string`	No	List ordering (mapped to order_by)
`team`	`string`	No	—
`limit`	`number`	No	Page size
`owner`	`string`	No	—
`offset`	`number`	No	Result offset
`archive`	`string \| boolean`	No	—
`project`	`string`	No	—
`language`	`string`	No	—
`video_id`	`string`	No	—
`video_url`	`string`	No	—

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  id: string,
  video_type?: string | null,
  primary_audio_language_code?: string | null,
  title?: string | null,
  description?: string | null,
  duration?: number | null,
  thumbnail?: string | null,
  created?: string | null,
  team?: string | null,
  project?: string | null,
  all_urls?: string[],
  metadata?: {
  },
  languages?: {
    code?: string,
    name?: string,
    published?: boolean,
    dir?: string | null,
    subtitles_uri?: string,
    resource_uri?: string
  }[],
  activity_uri?: string,
  urls_uri?: string,
  subtitle_languages_uri?: string,
  resource_uri?: string
}[]

listActivity

videos.listActivity List activity for a video Risk: read

await corsair.amara.api.videos.listActivity({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  id?: number | string,
  type?: number | string,
  type_name?: string,
  created?: string | null,
  video?: string | null,
  video_uri?: string | null,
  language?: string | null,
  language_url?: string | null,
  user?: {
    id?: string,
    username?: string,
    uri?: string
  } | string | null,
  comment?: string | null,
  new_video_title?: string | null,
  resource_uri?: string
}[]

listSubtitleActions

videos.listSubtitleActions List available subtitle actions Risk: read

await corsair.amara.api.videos.listSubtitleActions({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—

Output: object[]

Output full type

{
  action: string,
  label?: string,
  complete?: boolean | null
}[]

listSubtitleLanguages

videos.listSubtitleLanguages List subtitle languages for a video Risk: read

await corsair.amara.api.videos.listSubtitleLanguages({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  created?: string | null,
  language_code?: string,
  is_primary_audio_language?: boolean,
  is_rtl?: boolean,
  soft_limit_cpl?: number | null,
  soft_limit_cps?: number | null,
  soft_limit_lines?: number | null,
  soft_limit_max_duration?: number | null,
  soft_limit_min_duration?: number | null,
  published?: boolean,
  name?: string | null,
  title?: string | null,
  description?: string | null,
  metadata?: {
  },
  subtitle_count?: number,
  subtitles_complete?: boolean,
  versions?: {
    author?: {
      id?: string,
      username?: string,
      uri?: string
    } | null,
    published?: boolean,
    version_number?: number,
    created?: string | null
  }[],
  subtitles_uri?: string,
  resource_uri?: string
}[]

listSubtitleNotes

videos.listSubtitleNotes List editor notes on a subtitle set Risk: read

await corsair.amara.api.videos.listSubtitleNotes({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  body?: string,
  created?: string | null,
  user?: {
    id?: string,
    username?: string,
    uri?: string
  } | null
}[]

listUrls

videos.listUrls List URLs associated with a video Risk: read

await corsair.amara.api.videos.listUrls({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`limit`	`number`	No	Page size
`offset`	`number`	No	Result offset

Output

Name	Type	Required	Description
`meta`	`object`	No	—
`objects`	`object[]`	No	—

meta full type

{
  previous?: string | null,
  next?: string | null,
  offset?: number,
  limit?: number,
  total_count?: number
}

objects full type

{
  created?: string | null,
  url?: string,
  primary?: boolean,
  original?: boolean,
  id?: number,
  resource_uri?: string,
  videoid?: string | null,
  type?: string | null
}[]

makeUrlPrimary

videos.makeUrlPrimary Set a video URL as primary Risk: write

await corsair.amara.api.videos.makeUrlPrimary({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`url_id`	`string \| number`	Yes	—
`primary`	`boolean`	Yes	—

Output

Name	Type	Required	Description
`created`	`string`	No	—
`url`	`string`	No	—
`primary`	`boolean`	No	—
`original`	`boolean`	No	—
`id`	`number`	No	—
`resource_uri`	`string`	No	—
`videoid`	`string`	No	—
`type`	`string`	No	—

performSubtitleAction

videos.performSubtitleAction Perform a subtitle action (publish, save-draft, …) Risk: write

await corsair.amara.api.videos.performSubtitleAction({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—
`action`	`string`	Yes	—

Output

Name	Type	Required	Description
`ok`	`true`	No	—

update

videos.update Update video metadata Risk: write

await corsair.amara.api.videos.update({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`duration`	`number`	No	—
`team`	`string`	No	—
`project`	`string`	No	—
`thumbnail`	`string`	No	—
`metadata`	`object`	No	—
`primary_audio_language_code`	`string`	No	—

metadata full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`video_type`	`string`	No	—
`primary_audio_language_code`	`string`	No	—
`title`	`string`	No	—
`description`	`string`	No	—
`duration`	`number`	No	—
`thumbnail`	`string`	No	—
`created`	`string`	No	—
`team`	`string`	No	—
`project`	`string`	No	—
`all_urls`	`string[]`	No	—
`metadata`	`object`	No	—
`languages`	`object[]`	No	—
`activity_uri`	`string`	No	—
`urls_uri`	`string`	No	—
`subtitle_languages_uri`	`string`	No	—
`resource_uri`	`string`	No	—

metadata full type

{
}

languages full type

{
  code?: string,
  name?: string,
  published?: boolean,
  dir?: string | null,
  subtitles_uri?: string,
  resource_uri?: string
}[]

updateSubtitleLanguage

videos.updateSubtitleLanguage Update subtitle language settings Risk: write

await corsair.amara.api.videos.updateSubtitleLanguage({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—
`language_code`	`string`	Yes	—
`is_primary_audio_language`	`boolean`	No	—
`soft_limit_cpl`	`number`	No	—
`soft_limit_cps`	`number`	No	—
`soft_limit_lines`	`number`	No	—
`soft_limit_max_duration`	`number`	No	—
`soft_limit_min_duration`	`number`	No	—
`subtitles_complete`	`boolean`	No	—

Output

Name	Type	Required	Description
`created`	`string`	No	—
`language_code`	`string`	No	—
`is_primary_audio_language`	`boolean`	No	—
`is_rtl`	`boolean`	No	—
`soft_limit_cpl`	`number`	No	—
`soft_limit_cps`	`number`	No	—
`soft_limit_lines`	`number`	No	—
`soft_limit_max_duration`	`number`	No	—
`soft_limit_min_duration`	`number`	No	—
`published`	`boolean`	No	—
`name`	`string`	No	—
`title`	`string`	No	—
`description`	`string`	No	—
`metadata`	`object`	No	—
`subtitle_count`	`number`	No	—
`subtitles_complete`	`boolean`	No	—
`versions`	`object[]`	No	—
`subtitles_uri`	`string`	No	—
`resource_uri`	`string`	No	—

metadata full type

{
}

versions full type

{
  author?: {
    id?: string,
    username?: string,
    uri?: string
  } | null,
  published?: boolean,
  version_number?: number,
  created?: string | null
}[]

viewDetails

videos.viewDetails Get details for a single video by id Risk: read

await corsair.amara.api.videos.viewDetails({});

Input

Name	Type	Required	Description
`video_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`video_type`	`string`	No	—
`primary_audio_language_code`	`string`	No	—
`title`	`string`	No	—
`description`	`string`	No	—
`duration`	`number`	No	—
`thumbnail`	`string`	No	—
`created`	`string`	No	—
`team`	`string`	No	—
`project`	`string`	No	—
`all_urls`	`string[]`	No	—
`metadata`	`object`	No	—
`languages`	`object[]`	No	—
`activity_uri`	`string`	No	—
`urls_uri`	`string`	No	—
`subtitle_languages_uri`	`string`	No	—
`resource_uri`	`string`	No	—

metadata full type

{
}

languages full type

{
  code?: string,
  name?: string,
  published?: boolean,
  dir?: string | null,
  subtitles_uri?: string,
  resource_uri?: string
}[]

​Activity

​get

​list

​Languages

​listAvailable

​Messages

​send

​Teams

​addMember

​createProject

​deleteProject

​getDetails

​getLanguages

​getMember

​getProject

​getTask

​list

​listApplications

​listMembers

​listProjects

​listTasks

​removeMember

​updateMember

​updateProject

​Users

​getActivity

​getData

​Videos

​addSubtitleNote

​addUrl

​create

​createSubtitleLanguage

​createSubtitles

​deleteUrl

​fetchSubtitlesData

​getSubtitleLanguageDetails

​getUrl

​getUrlDetails

​list

​listActivity

​listSubtitleActions

​listSubtitleLanguages

​listSubtitleNotes

​listUrls

​makeUrlPrimary

​performSubtitleAction

​update

​updateSubtitleLanguage

​viewDetails

Activity

get

list

Languages

listAvailable

Messages

send

Teams

addMember

createProject

deleteProject

getDetails

getLanguages

getMember

getProject

getTask

list

listApplications

listMembers

listProjects

listTasks

removeMember

updateMember

updateProject

Users

getActivity

getData

Videos

addSubtitleNote

addUrl

create

createSubtitleLanguage

createSubtitles

deleteUrl

fetchSubtitlesData

getSubtitleLanguageDetails

getUrl

getUrlDetails

list

listActivity

listSubtitleActions

listSubtitleLanguages

listSubtitleNotes

listUrls

makeUrlPrimary

performSubtitleAction

update

updateSubtitleLanguage

viewDetails