You need to enable JavaScript to run this app.
视频点播

视频点播

复制全文
Aideo Agent
GetAideoTaskResult - 获取智能视频处理任务结果
复制全文
GetAideoTaskResult - 获取智能视频处理任务结果

调用 GetAideoTaskResult 接口通过任务 ID 获取一个异步智能视频处理任务的执行状态和详细结果。

使用说明

Aideo Agent 在执行过程中,可能会调用一个或多个底层的视频点播原子能力(如 AI 视频翻译、高光分析等)。本接口的返回结果 ApiResponses 是一个数组,聚合了所有这些底层调用的详细结果。您需要根据提交任务时使用的 SkillType,来解析 ApiResponses 数组中对应的结果对象。

注意事项

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

请求说明

  • 请求方式:GET
  • 请求地址:https://vod.volcengineapi.com?Action=GetAideoTaskResult&Version=2025-03-03

调试

请求参数

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

Query

参数
类型
是否必选
示例值
描述
Action
String
GetAideoTaskResult
接口名称。当前 API 的名称为 GetAideoTaskResult
Version
String
2025-03-03
接口版本。当前 API 的版本为 2025-03-03
SpaceName
String
test

点播空间名。您可通过以下方式获取空间名称:

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace接口获取当前账号下所有空间的名称。
TaskId
String
cc058a95-95e8-47a1-bf9e-4272***f9022
智能视频处理任务的 ID。您可在 SubmitAideoTaskAsync 接口的返回参数中获取此 ID。

返回参数

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

参数
类型
示例值
描述
TaskId
String
43b343a1-8bdf-4785-831d-e78b1c***afc
智能视频处理任务的 ID。
Status
String
Completed

Aideo Agent 任务状态,取值如下:

  • Processing :处理中
  • Completed:处理完成
  • Failed:处理失败
SkillType
String
Highlight

您提交任务时使用的 AI 技能类型。您需要参考此字段解析 ApiResponses。取值如下:

  • AITranslation:AI 视频翻译
  • Erase:AI 字幕擦除
  • Highlight:AI 高光剪辑
  • VCreative:AI 剪辑
  • Vision:AI 视频理解
MultiInputs
Object[]
-
您提交任务时传入的输入文件信息。
Vid
String
v0c5a9g700**41ld67og65ur5d01b1g
视频 ID。
Type
String
Vid
输入文件类型。当前仅支持取值为 Vid,表示 Vid 模式。
SkillParams
String
{"TranslationConfig":{"SourceLanguage":"zh","TargetLanguage":"en","TranslationTypeList":["SubtitleTranslation","VoiceTranslation"]},"OperatorConfig":{"SubtitleRecognitionConfig":{"RecognitionType":"ASR"}},"SubtitleConfig":{"IsHardSubtitle":true,"IsEraseSource":false,"FontSize":24,"MarginV":0.1}}
您提交任务时传入的 SkillParams 字符串。当您使用 Prompt 方式提交任务时,此字段会返回 Agent 自动为您解析出的等价 SkillParams
ApiResponses
Object[]
-
智能视频处理任务执行结果。ApiResponses 是一个对象数组,数组中的每个对象代表 Agent 在执行过程中调用的一个底层 AI 原子能力的结果。
VodTaskType
String
AITranslation

点播任务类型,同 SkillType。取值如下:

  • AITranslation:AI 视频翻译
  • Erase:AI 字幕擦除
  • Highlight:AI 高光剪辑
  • VCreative:AI 剪辑
  • Vision:AI 视频理解
Status
String
success
点播任务状态,和点播任务类型相关,具体取值取决于底层 AI 原子能力的执行结果。
ProjectId
String
691187c5f51a52140dda35a9
AI 视频翻译项目 ID。仅当使用 AITranslation 技能时会返回该值。
ProjectVersion
String
d11f7135d92d4db9a27548ea598847fb
AI 视频翻译项目版本。仅当使用 AITranslation 技能时会返回该值。
AITranslation
Object
-
AI 视频翻译结果。仅当使用 AITranslation 技能时会返回该值。
ProjectInfo
Object
-
项目信息
Status
String

项目状态,取值如下:

  • InProcessing:处理中
  • ProcessSuspended:处理暂停
  • ProcessSucceed:处理完成
  • ProcessFailed:处理失败
  • InExporting:导出中
  • ExportSucceed:导出完成
  • ExportFailed:导出失败
OutputVideo
Object
-
输出视频信息
IsAudio
Boolean
true
是否为音频
Uri
String
tos-vod-cn-v-f724fac40***19c6/example.mp4
文件存储路径
Vid
String
v0299fg***4d103gsqljht10tatbreg
文件 Vid。仅在 InputVideoOutputVideo 结构中此字段有值。
DurationSecond
Double
159.104
文件时长,单位为秒
Url
String
https://example.volcvideo.com/example.mp4
文件访问 URL
FileName
String
video.mp4
文件路径,可用于拼接访问地址
VoiceTranslationVideo
Object
-
语音翻译视频信息
IsAudio
Boolean
true
是否为音频
Uri
String
tos-vod-cn-v-f724fac40***19c6/example.mp4
文件存储路径
Vid
String
v0299fg***4d103gsqljht10tatbreg
文件 Vid。仅在 InputVideoOutputVideo 结构中此字段有值。
DurationSecond
Double
159.104
文件时长,单位为秒
Url
String
https://example.volcvideo.com/example.mp4
文件访问 URL
FileName
String
video.mp4
文件路径,可用于拼接访问地址
FacialTranslationVideo
Object
-
面容翻译视频信息
IsAudio
Boolean
true
是否为音频
Uri
String
tos-vod-cn-v-f724fac40***19c6/example.mp4
文件存储路径
Vid
String
v0299fg***4d103gsqljht10tatbreg
文件 Vid。仅在 InputVideoOutputVideo 结构中此字段有值。
DurationSecond
Double
159.104
文件时长,单位为秒
Url
String
https://example.volcvideo.com/example.mp4
文件访问 URL
FileName
String
video.mp4
文件路径,可用于拼接访问地址
RunId
String
bb:a18f1dd***ebf6f2da8f1c79a7abfb14
视频处理任务 ID。仅当使用 EraseHighlightVision 技能时会返回该值。
Erase
Object
-
AI 字幕擦除任务结果,仅当使用 Erase 技能时会返回该值。
Duration
Double
152.085
输出视频时长,单位为秒。
File
Object
-
输出文件信息
Size
String
2519064
文件大小,单位为字节。
FileName
String
9c78b9bbb841***586252231dadc9422_speech.aac
文件路径。
Vid
String
v0299fg***4d103gsqljht10tatbreg
文件 Vid。
Info
Object
-
擦除详细信息。仅当提交任务时 Erase.WithEraseInfo 设为 true时会返回该值。
Width
Integer
1920
擦除后视频的宽度,单位为像素。
Height
Integer
1080
擦除后视频的高度,单位为像素。
Areas
Object[]
-
擦除区域信息
Start
Double
13.88
开始时间,单位为秒。
End
Double
15.88
结束时间,单位为秒。
PixelRectangle
Object[]
-
擦除区域位置信息
TopLeftX
Integer
108
擦除区域左上角相对于视频左上角在 X 轴上的偏移,单位为像素
TopLeftY
Integer
960
擦除区域左上角相对于视频左上角在 Y 轴上的偏移,单位为像素
BottomRightX
Integer
1067
擦除区域右下角相对于视频左上角在 X 轴上的偏移,单位为像素
BottomRightY
Integer
1919
擦除区域右下角相对于视频左上角在 Y 轴上的偏移,单位为像素
Highlight
Object
-
AI 高光剪辑任务结果。仅当使用 Highlight 技能时会返回该值。
Duration
Double
75.093333
输入视频总时长,单位为秒。
Clips
Object[]
-
高光片段信息。当请求参数 Highlight.ModeClips(高光片段模式)时返回。
Start
Double
0.52
高光片段开始时间,单位为秒。
End
Double
3.52
高光片段结束时间,单位为秒。
VideoIndex
Integer
0
输入视频标识,用以指明该片段源自哪个输入视频,编号从 0 开始。
Edits
Object[]
-
自动剪辑产物信息。当您在请求参数中配置了 Highlight.Edit 时,此字段会返回自动剪辑生成的高光视频的信息。
Size
String
2519064
文件大小,单位为字节。
FileName
String
9c78b9bbb841***586252231dadc9422_speech.aac
文件路径。
Vid
String
v0299fg***4d103gsqljht10tatbreg
文件 Vid。
HighlightCuts
Object
-
高光片段信息。当请求参数 Highlight.ModeStorylineCuts(混剪模式)时返回。
Cuts
Object[]
-
高光片段信息。
Clips
Object[]
-
高光片段信息
Type
String
HighlightClip

片段类型:

  • HighlightClip:普通高光片段
  • OpeningHook:视频前置精彩片段。仅当请求参数 WithOpeningHooktrue 时返回。
Score
Double
3.5
高光打分,取值范围为 [1,5]。
Start
Double
13.88
该片段在原始视频中的起始时间点,单位为秒。
End
Double
15.88
该片段在原始视频中的结束时间点,单位为秒。
VideoIndex
Integer
0
输入视频标识,用以指明该片段源自哪个输入视频,编号从 0 开始。
CutStart
Double
13.88
该片段在最终高光混剪视频中的起始时间点,单位为秒。
CutEnd
Double
15.88
该片段在最终高光混剪视频中的结束时间点,单位为秒。
Storyboard
Object[]
-
视频分镜信息。算法会基于分镜理解分析输出视频片段信息。仅当请求中 WithStoryboard 参数为 true 时返回。
VideoIndex
Integer
0
输入视频标识,用以指明该片段源自哪个输入视频,编号从 0 开始。
Start
Double
133.0
片段开始时间,单位为秒。
End
Double
181.0
片段结束时间,单位为秒。
Score
Double
3.5
高光打分,取值范围为 [1,5]。
Ocr
String
字幕
字幕 OCR 识别。仅识别位于画面下半部分且居中的字幕。
Description
String
描述
画面描述。
StorylineCuts
Object
-
混剪信息。当请求参数 Highlight.ModeStorylineCuts(混剪模式)时返回。
Segments
Object[]
-
视频片段信息。算法会基于分镜理解分析输出视频片段,包含的信息最为全面。
Start
Double
133.0
片段开始时间,单位为秒。
End
Double
181.0
片段结束时间,单位为秒。
Score
Double
3.5
高光值,取值范围为 [1,5]。
Ocr
String
字幕
字幕 OCR 识别。仅识别位于画面下半部分且居中的字幕。
Description
String
描述
画面描述。
Location
String
公司
地点标签。
Shot
String
特写

景别标签:

  • 特写: 面部或细节

  • 近景: 胸部以上

  • 中景: 腰部以上

  • 全景: 全身

  • 远景: 环境为主

VideoIndex
Integer
0
输入视频标识,用以指明该片段源自哪个输入视频,编号从 0 开始。
Storylines
Object[]
-
故事线信息。算法会将 segments 中属于同一故事情节的部分整理成连贯的故事线。
Title
String
标题
标题
Description
String
描述
描述
Score
Double
3.5
高光打分,取值范围为 [1,5]
Segments
Integer[]
[0,1,2]
片段索引信息,编号从 0 开始
CutSegments
Object[]
-
算法根据 StartExecution 接口请求参数中输入的条件限制,从故事线中提取最精彩的片段。若请求参数中没有条件限制,则默认剔除视频中高光分数 ≤1 以及 1 < 高光分数 ≤2 且无台词的片段。
Segments
Integer[]
[0,1,2]
片段索引信息,编号从 0 开始
Vision
Object
-
AI 视频理解任务结果。仅当使用 Vision 技能时会返回该值。
Duration
Double
70.1
视频时长,单位为秒。
SnapshotsNumber
Integer
50
截图张数。
Model
Object
-
视频理解任务大模型用量。
DoubaoInputTokens
Integer
2564
豆包 VLM 输入令牌数量。
DoubaoOutputTokens
Integer
528
豆包 VLM 输出令牌数量。
DoubaoTotalTokens
Integer
3092
豆包 VLM 总计令牌数量。
DoubaoTextInputTokens
Integer
2564
豆包 LLM 输入令牌数量。
DoubaoTextTotalTokens
Integer
528
豆包 LLM 输出令牌数量。
DoubaoTextOutputTokens
Integer
3092
豆包 LLM 总计令牌数量。
Content
String
视频展示的是xxx。以下是视频的具体内容xxx
视频理解结果。
VCreativeId
String
20251010v182730c070c0e43cbf406***f9c657781b5tob
AI 剪辑任务 ID。仅当使用 VCreative 技能时会返回该值。
VCreative
Object
-
AI 剪辑任务结果。仅当使用 VCreative 技能时会返回该值。
Status
String
success

AI 剪辑任务的状态,可能的取值如下:

  • pending:排队中
  • start:执行中
  • success:执行成功
  • failed_run:执行失败
  • user_canceled:用户取消
  • failed_invoke_lambda:服务间调用失败
Uploader
String
edit_test
任务产物的上传空间。AI 处理生成的视频将被上传至此点播空间。
ParamJson
String
{"Text":"将第一个视频和第二个视频拼接到一起"}
AI 剪辑任务的参数,JSON 序列化后的字符串形式,包含任务描述、上传空间、上下文 ID 和素材列表等信息。
RequestId
String
2025102220****C78ADC30A0418952624D
请求 ID。
OutputJson
String
OutputJson
任务的输出结果,是一个 JSON 格式的字符串您需要对其进行 JSON 解析以获取内部字段。其内部结构取决于任务所执行的工作流类型。
WorkflowId
String
137877774
AI 剪辑任务工作流 ID
CallbackArgs
String
Your_Callback_Args
自定义回调参数。该参数值会通过 VCreativeComplete 事件中的 CallbackArgs 参数返回您的服务端。
Error
Object
-
当任务执行过程中出现错误时会返回该值。
Code
String
InternalError
错误码
Message
String
AITranslation task failed with code InternalError.
错误信息

请求示例

GET https://vod.volcengineapi.com?Action=GetAideoTaskResult&Version=2025-03-03&SpaceName=test-space&TaskId=f283fc36-cbc8-4c33-aec1-f972307111b7

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "GetAideoTaskResult",
    "Version": "2025-03-03",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskId": "43b343a1-8bdf-4785-831d-e78b1cd4aafc",
    "Status": "Completed",
    "SkillType": "VCreative",
    "MultiInputs": [
      {
        "Type": "Vid",
        "Vid": "v0dbffg***64d4a069iljht2afjba1v0"
      },
      {
        "Type": "Vid",
        "Vid": "v0dbffg***64d49vilqljht47t2qrdt0"
      }
    ],
    "SkillParams": "{\"Text\":\"将第1个视频的前10s,第2个视频的5-10s 拼接到一起,并添加旋转放大的转场过渡\"}",
    "ApiResponses": [
      {
        "VodTaskType": "VCreative",
        "Status": "success",
        "VCreative": {
          "Status": "success",
          "Uploader": "test-space",
          "ParamJson": "{\"Text\":\"将视频1、2拼接到一起\",\"Uploader\":\"test-space\",\"ContextID\":\"\",\"MaterialList\":[\"vid://v0dbffg***64d4a069iljht2afjba1v0\",\"vid://v0dbffg***64d49vilqljht47t2qrdt0\"]}",
          "RequestId": "202511121436442539828CE3B9E702EA2D",
          "OutputJson": "{\"Result\":{\"Codec\":\"h264\",\"Duration\":114.413,\"FileName\":null,\"Height\":1280,\"Resolution\":\"720P\",\"Size\":19774712,\"SplitFlag\":true,\"Uri\":\"test-space/2a1ade4***4f4efa9150aaf0b14860af.mp4\",\"Vid\":\"v0dbffg***64d4a2mfiljht8f4k8j6dg\",\"Width\":720,\"runt_infos\":{\"download_time\":0.9422671794891357,\"function_time\":3.172301763534546,\"other_time\":0.867387052536011,\"total_time\":7.935031414031982,\"upload_time\":2.95307541847229}}}",
          "WorkflowId": "137877774",
          "CallbackArgs": "{\"Func\":\"\",\"Space\":\"test-space\",\"StartTime\":\"2025-11-12T14:36:45.317677948+08:00\",\"AccountId\":\"2100007144\",\"WorkflowId\":\"137877774\"}"
        },
        "VCreativeId": "20251010v182730c070c0e43cbf4063aaf9c657781b5tob"
      }
    ]
  }
}

错误码

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

最近更新时间:2025.11.19 20:52:41
这个页面对您有帮助吗?
有用
有用
无用
无用