ListAITranslationProject - 获取 AI 翻译项目列表--视频点播-火山引擎

文档中心

立即注册

视频点播

翻译项目与工作流管理

ListAITranslationProject - 获取 AI 翻译项目列表

调用 ListAITranslationProject 接口查询指定空间中的 AI 翻译项目列表，支持按项目状态过滤和分页查询。返回结果包括输入和输出视频信息。

注意事项

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListAITranslationProject&Version=2025-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`ListAITranslationProject`	接口名称。当前 API 的名称为 `ListAITranslationProject`。
Version	String	是	`2025-01-01`	接口版本。当前 API 的版本为 `2025-01-01`。
SpaceName	String	是	`test`	点播空间名。您可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace接口获取当前账号下所有空间的名称。
PageNumber	Integer	否	`1`	分页查询的页码编号，默认值为 `1`。
PageSize	String	否	`10`	每页返回的任务数量，默认值为 `10`。
StatusFilter	String	否	`InProcessing,ProcessSucceed`	任务状态，多个状态可用逗号分隔。不传返回所有状态的任务。支持的状态取值： `InProcessing`：处理中 `ProcessSucceed`：处理完成 `ProcessFailed`：处理失败 `InExporting`：导出中 `ExportSucceed`：导出完成 `ExportFailed`：导出失败
ProjectIdOrTitleFilter	String	否	`project123`	项目 ID 或项目名称。您可通过以下方式获取项目 ID：在 SubmitAITranslationWorkflow 接口的返回参数中获取。配置 AI 翻译任务执行完成事件。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Projects	Object[]	`-`	项目信息列表
ProjectId	String	`684038d6b***9005b266fefe`	项目 ID
ProjectVersion	String	`01c4fa5da***48a588a46f81e282b100`	项目版本
WorkflowId	String	`684038d6b***9005b266fefd`	工作流 ID
CreatedAt	String	`1749039318`	项目创建时间，Unix 时间戳，精度为秒。
UpdatedAt	String	`1749039973`	项目更新时间，Unix 时间戳，精度为秒。
Status	String	`ProcessSucceed`	项目状态，取值如下： `InProcessing`：处理中 `ProcessSuspended`：处理暂停 `ProcessSucceed`：处理完成 `ProcessFailed`：处理失败 `InExporting`：导出中 `ExportSucceed`：导出完成 `ExportFailed`：导出失败
InputVideoPosterUrl	String	`https://example.bytedance.com/tos-vod-cn-v-f724fac4091119c6/oM90fAzdSEvgtE***QQBVVfSWAJmx4ZH~noop.jpeg`	输入视频封面 URL
InputVideoTitle	String	`example.mp4`	输入视频名称
TranslationTypeList	String[]	`["SubtitleTranslation","VoiceTranslation", "FacialTranslation"]`	执行的翻译类型组合，支持以下选项： `["SubtitleTranslation"]`：仅文本翻译。 `["SubtitleTranslation","VoiceTranslation"]`：文本和语音翻译。 `["SubtitleTranslation","VoiceTranslation", "FacialTranslation"]`：文本、语音和面容翻译。说明翻译类型详细介绍请见声影智译。
SubtitleConfig	Object	`-`	字幕配置
FontSize	Integer	`24`	硬字幕的字体大小，单位为像素。取值范围为 [1, 80]。注意当 `IsHardSubtitle` 为 `true` 时，此参数必填。
MarginL	Double	`0.1`	硬字幕距离视频左侧的距离比例，取值范围为 [0, 1)。注意当 `IsHardSubtitle` 为 `true` 时，此参数必填。
MarginR	Double	`0`	硬字幕距离视频右侧的距离比例，取值范围为 [0, 1)。注意当 `IsHardSubtitle` 为 `true` 时，此参数必填。
MarginV	Double	`0`	硬字幕距离视频底部的距离比例，取值范围为 [0, 1)。注意当 `IsHardSubtitle` 为 `true` 时，此参数必填。
ShowLines	Integer	`2`	硬字幕最多显示的行数。取值为 `0` 时表示不限制行数。注意当 `IsHardSubtitle` 为 `true` 时，此参数必填。
IsHardSubtitle	Boolean	`false`	是否为硬字幕。开启后，字幕将直接嵌入视频画面中，不可关闭或调整。注意当开启硬字幕时，以下参数必填： `MarginL` `MarginR` `MarginV` `FontSize` `ShowLines`
IsEraseSource	Boolean	`true`	是否擦除视频中的原有字幕。开启后，系统将在生成新字幕前擦除视频中的原有字幕。说明字幕擦除为收费功能，按实际输出视频时长计费，具体价格请参考视频 AI 应用计费。
InputVideo	Object	`-`	输入视频信息
IsAudio	Boolean	`true`	是否为音频
Uri	String	`tos-vod-cn-v-f724fac40***19c6/example.mp4`	文件存储路径
Vid	String	`v0299fg***4d103gsqljht10tatbreg`	文件 Vid。仅在 `InputVideo` 和 `OutputVideo` 结构中此字段有值。
DurationSecond	Double	`159.104`	文件时长，单位为秒
Url	String	`https://example.volcvideo.com/example.mp4`	文件访问 URL
FileName	String	`video.mp4`	文件路径，可用于拼接访问地址。
OutputVideo	Object	`-`	输出视频信息
IsAudio	Boolean	`true`	是否为音频
Uri	String	`tos-vod-cn-v-f724fac40***19c6/example.mp4`	文件存储路径
Vid	String	`v0299fg***4d103gsqljht10tatbreg`	文件 Vid。仅在 `InputVideo` 和 `OutputVideo` 结构中此字段有值。
DurationSecond	Double	`159.104`	文件时长，单位为秒
Url	String	`https://example.volcvideo.com/example.mp4`	文件访问 URL
FileName	String	`video.mp4`	文件路径，可用于拼接访问地址。
SourceBlueprints	Object[]	`-`	源蓝图
Id	String	`684038d6b71c9005b266feff`	蓝图 ID
Language	String	`zh`	语言，取值如下： `en`：英文 `ja`：日文 `es`：西班牙语 `pt`：葡萄牙语 `zh`：中文 `id`：印尼语
ProjectId	String	`684038d6b71c9005b266fefe`	项目 ID
TranslationType	String	`source`	翻译类型，取值如下： `source`：源语言 `target`：目标语言
TargetBlueprints	Object[]	`-`	目的蓝图
Id	String	`684038d6b71c9005b266feff`	蓝图 ID
Language	String	`zh`	语言，取值如下： `en`：英文 `ja`：日文 `es`：西班牙语 `pt`：葡萄牙语 `zh`：中文 `id`：印尼语
ProjectId	String	`684038d6b71c9005b266fefe`	项目 ID
TranslationType	String	`source`	翻译类型，取值如下： `source`：源语言 `target`：目标语言
OperatorConfig	Object	`-`	操作配置
SubtitleRecognitionConfig	Object	`-`	字幕识别配置。字幕来源默认为 OCR。
RecognitionType	String	`OCR`	字幕来源，取值如下： `OCR`：从视频的画面中识别文字并生成字幕。 `ASR`：从视频的音轨中识别文字并生成字幕。 `SourceSubtitleFile`：使用您提供的源语言字幕文件。选择此项时，必须配置 `SourceSubtitleFileName` 参数。 `SourceAndTargetSubtitleFile`：使用您提供的源语言和目标语言字幕文件。选择此项时，必须同时配置 `SourceSubtitleFileName` 和 `TargetSubtitleFileName` 参数。 `BilingualSubtitleFile`：使用您提供的双语字幕文件。选择此项时，必须配置 `BilingualSubtitleFileName` 参数。 `SubtitleFile`：（已废弃）行为等同于 `SourceSubtitleFile`。说明使用您自行提供的字幕文件作为来源时，您必须：预先将字幕文件作为素材上传至项目所在的点播空间。字幕文件可以是源语言字幕文件、目标语言字幕文件或双语字幕文件，支持 WebVTT、SRT 格式。获取该字幕文件的 FileName。配置 `SourceSubtitleFileName`、`TargetSubtitleFileName` 或 `BilingualSubtitleFileName` 中的一个或多个参数。
SourceSubtitleFileName	String	`source_subtitle.vtt`	源语言字幕文件的 FileName。当 `RecognitionType` 为 `SourceSubtitleFile` 或 `SourceAndTargetSubtitleFile` 时必填。
TargetSubtitleFileName	String	`target_subtitle.vtt`	目标语言字幕文件的 FileName。当 `RecognitionType` 为 `SourceAndTargetSubtitleFile` 时必填。
BilingualSubtitleFileName	String	`dual_subtitle.vtt`	双语字幕文件的 FileName。当 `RecognitionType` 为 `BilingualSubtitleFile` 时必填。
SubtitleFileName	String	`subtitle.vtt`	（已废弃）字幕文件的 FileName。当字幕来源 `RecognitionType` 为 `SubtitleFile` 时必填。注意此参数已被 `SourceSubtitleFileName`、`TargetSubtitleFileName` 和 `BilingualSubtitleFileName` 替代，建议您在后续开发中使用新参数。为保证兼容，该参数仍然有效，其行为等同于 `SourceSubtitleFileName`。
IsVision	Boolean	`true`	是否开启视频理解。开启后，系统将综合理解视频画面和语音内容来生成字幕，识别结果更精准但耗时较长。默认值为 `false`。此模式需提交工单联系火山引擎技术支持团队申请加入白名单后方可使用。
VoiceCloneConfig	Object	`-`	声音克隆与合成配置。当翻译类型 `TranslationTypeList` 包含 `VoiceTranslation` 时，您可以通过此参数对最终合成的音频进行精细化控制。
BackgroundVolume	Integer	`100`	背景音音量。用于调节最终合成视频中背景音的音量大小。默认值为 `100`，表示保持原始背景音音量不变。取值范围为 `[0, 100]`。设置为 `0` 表示背景音完全静音。
ErrorMsg	String	`ErrorMsg`	错误信息
ErrorCode	Integer	`0`	错误码： `0`：任务执行成功 `500200`：回调状态为空 `500210`：AI 翻译后处理失败 `500100`：AI 翻译工作流内部错误 `500110`：背景音分离失败 `500120`：字幕文本翻译失败 `500130`：语音翻译失败 `500140`：面容翻译失败
TotalCount	Integer	`2`	项目总数
PageSize	Integer	`10`	每页显示的项目数量
PageNumber	Integer	`1`	当前查询的页码

请求示例

https://vod.volcengineapi.com?Action=ListAITranslationProject&Version=2025-01-01&SpaceName=test

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "ListAITranslationProject",
    "Version": "2025-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Projects": [
      {
        "ProjectId": "684038d6b7***005b266fefe",
        "ProjectVersion": "01c4fa5da3d648a5***46f81e282b100",
        "WorkflowId": "684038d6***c9005b266fefd",
        "CreatedAt": "1749039318",
        "UpdatedAt": "1749039973",
        "Status": "ProcessSucceed",
        "InputVideoPosterUrl": "https://example.bytedance.com/tos-vod-cn-v-f724fac***1119c6/oM90fAzdSEvgtE***QQBVVfSWAJmx4ZH~noop.jpeg",
        "InputVideoTitle": "example.mp4",
        "TranslationTypeList": [
          "SubtitleTranslation",
          "VoiceTranslation",
          "FacialTranslation"
        ],
        "InputVideo": {
          "Uri": "tos-vod-cn-v-f724f***091119c6/败给月光1.mp4",
          "Url": "https://example.volcvideo.com/%E8%B4%A5%E7%BB%99%E6%9C%88%E5%85%891.mp4",
          "Vid": "v0299fg***4d103gsqljht10tatbreg",
          "IsAudio": true,
          "DurationSecond": 159.104
        },
        "OutputVideo": {
          "Uri": "tos-vod-cn-v-f724f***091119c6/败给月光1.mp4",
          "Url": "https://example.volcvideo.com/%E8%B4%A5%E7%BB%99%E6%9C%88%E5%85%891.mp4",
          "Vid": "v0299fg***4d103gsqljht10tatbreg",
          "IsAudio": true,
          "DurationSecond": 159.104
        },
        "SourceBlueprints": [
          {
            "Id": "684038d6b7***005b266feff",
            "Language": "zh",
            "ProjectId": "684038d6b71c***5b266fefe",
            "TranslationType": "source"
          }
        ],
        "TargetBlueprints": [
          {
            "Id": "684038d6b7***005b266feff",
            "Language": "en",
            "ProjectId": "684038d6b7***005b266fefe",
            "TranslationType": "target"
          }
        ],
        "OperatorConfig": {
          "SubtitleRecognitionConfig": {
            "RecognitionType": "OCR"
          }
        },
        "ErrorMsg": "ErrorMsg",
        "ErrorCode": 0
      }
    ],
    "TotalCount": 2,
    "PageSize": 10,
    "PageNumber": 1
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

SDK

视频点播为 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。本接口仅 VOD SDK 2.0 支持，详见 V2.0 SDK 介绍与迁移说明。

最近更新时间：2025.12.29 11:27:40

这个页面对您有帮助吗？

有用

无用

视频点播

注意事项 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

SDK #