StartAIWorkflow - 提交智能工作流任务

通过调用StartAIWorkflow接口,您可以提交智能工作流任务,从而实现基于智能工作流模板的自动化智能媒体服务流程。

接口说明

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:StartAIWorkflowcreate
*全部资源
*

请求参数

名称类型必填描述示例值
WorkflowIdstring

智能工作流模板 ID

****3f44-f1f6-477e-9364-c5e6c49e****
Inputsstring

智能工作流启动参数,Json 字符串形式,比如媒资或者直播/RTC 流信息等。

{ "live_url": { "Url": "rtmp://test.com/test_app/test_stream?auth_key=test", "MaxIdleTime": 20 }, "source_language_id": "es" }
UserDatastring

用户自定义信息,非必填

{ "url":"https://test.com" }
DispatchTagstring

任务标签,非必填

default

Inputs:在智能工作流模板的开始节点中进行配置,支持多参数、多参数类型,可根据工作流模板的实际流程需要进行定义。可参考如下场景示例:

  • 直播翻译:
{
	"live_url": {
		"Url": "rtmp://test.com/test_app/test_stream?auth_key=test",
     "MaxIdleTime": 20
	},
	"source_language_id": "es"
}
  • RTC 字幕翻译
{
	"rtc": {
		"AppId": "xxx",
		"ChannelId": "rtcaitest1",
		"UserId": "userA"
	},
  "source_language_id": "zh",
  "push_app_id": "app_id",
  "push_channel_id": "channel_id",
  "push_uid": "user_id"
}
  • 媒体处理
{
  "TaskInput":{
      "Type":"OSS",
      "Media": "oss://sashimi-cn-shanghai/test/test.flv"
   }
}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

******11-DB8D-4A9A-875B-275798******
TaskIdstring

智能工作流任务 ID。

********-266c-4bb8-b20c-6faa********

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "TaskId": "\n********-266c-4bb8-b20c-6faa********"
}

错误码

访问错误中心查看更多错误码。