StartAIWorkflow - Intelligent Media Services - Alibaba Cloud Documentation Center

Initiates a workflow task for automated media processing based on a workflow template.

Operation description

You must specify a workflow template. To create one, go to the Intelligent Media Services (IMS) console.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:StartAIWorkflow	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorkflowId	string	Yes	The ID of the workflow template.	**3f44-f1f6-477e-9364-c5e6c49e**
Inputs	string	No	A JSON string containing the specific input parameters, such as information about the media assets, standard live streams, or RTC streams.	{ "live_url": { "Url": "rtmp://test.com/test_app/test_stream?auth_key=test", "MaxIdleTime": 20 }, "source_language_id": "es" }
UserData	string	No	A user-defined parameter for passing custom metadata.	{ "url":"https://test.com" }
DispatchTag	string	No	The tag for the task.	default

The structure and required fields for the Inputs parameter are dynamically configured within the start node of the specific workflow template being used. Examples of common use cases:

Live translation:

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

RTC subtitle translation:

{
	"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"
}

Media processing:

{
  "TaskInput":{
      "Type":"OSS",
      "Media": "oss://sashimi-cn-shanghai/test/test.flv"
   }
}

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
TaskId	string	The ID of the workflow task.	******-266c-4bb8-b20c-6faa******

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.