All Products
Search
Document Center

Intelligent Media Services:GetAIWorkflowTask

Last Updated:Dec 23, 2025

Retrieves the details of a workflow task.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:GetAIWorkflowTaskget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringNo

The ID of the workflow task.

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

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

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

The information about the workflow task.

TaskIdstring

The ID of the workflow task.

********-67fd-43aa-9cc1-3e7f********
Statusstring

The task state.

Valid values:

  • running
  • stopped
  • failed
  • partial-succeeded
  • succeeded
succeeded
Inputsstring

The input parameters of the workflow task.

{\"source_language_id\":\"en\",\"live_id\":123,\"live_url\":{\"url\":\"rtmp://test.com.cn/video/638d9088fe4f15ce\"}}
CreateTimestring

The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2025-07-28T02:17:26Z
FinishTimestring

The time when the task was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2025-08-19T02:28:22Z
Workflowobject

The workflow template information.

WorkflowIdstring

The ID of the workflow template.

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

The name of the workflow template.

RealtimeTranslation
Statusstring

Workflow template status. Valid values:

  • Draft
  • Published
  • Editing
Draft
Typestring

The scenario type of the template.

Live
CreateTimestring

The time when the template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2025-08-20T01:35:04Z
ModifiedTimestring

The time when the template was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2025-08-20T01:35:04Z
Versionstring

The template version.

****ec0a-e3b9-40b1-abf2-6549d00e****
Graphstring

The workflow's topological structure.

{ "nodes":[...], "edges":[...] }
NodeResultsstring

The results of the workflow nodes. The structure of this JSON varies based on the workflow's configuration.

{...}
UserDatastring

The user-defined data.

{"NotifyAddress":"http://xx.xx.xxx"}
Outputsstring

The node output.

{ "result":"test" }
Versionstring

The version of the workflow template that was executed.

****ec0a-e3b9-40b1-abf2-6549d00e****

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "WorkflowTask": {
    "TaskId": "********-67fd-43aa-9cc1-3e7f********",
    "Status": "succeeded",
    "Inputs": "{\\\"source_language_id\\\":\\\"en\\\",\\\"live_id\\\":123,\\\"live_url\\\":{\\\"url\\\":\\\"rtmp://test.com.cn/video/638d9088fe4f15ce\\\"}}",
    "CreateTime": "2025-07-28T02:17:26Z",
    "FinishTime": "2025-08-19T02:28:22Z",
    "Workflow": {
      "WorkflowId": "****3f44-f1f6-477e-9364-c5e6c49e****",
      "Name": "RealtimeTranslation",
      "Status": "Draft",
      "Type": "Live",
      "CreateTime": "2025-08-20T01:35:04Z",
      "ModifiedTime": "2025-08-20T01:35:04Z",
      "Version": "****ec0a-e3b9-40b1-abf2-6549d00e****",
      "Graph": "{\n\"nodes\":[...],\n\"edges\":[...]\n}"
    },
    "NodeResults": "{...}",
    "UserData": {
      "NotifyAddress": "http://xx.xx.xxx"
    },
    "Outputs": {
      "result": "test"
    },
    "Version": "****ec0a-e3b9-40b1-abf2-6549d00e****"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-10-17Add OperationView Change Details