Use GetSmartHandleJob to query intelligent job information and results - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Retrieves the information and execution results for a Clipping Task using its Task ID. Only tasks submitted within the past year can be queried.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:GetSmartHandleJob

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The job ID.	**20b48fb04483915d4f2cd8ac**

Response elements

Element	Type	Description	Example
	object	The body of the response.
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
JobId	string	The ID of the job.	**20b48fb04483915d4f2cd8ac**
Output	string	The job output.	{}
JobResult	object	The job results.
MediaId	string	The ID of the media asset.	**20b48fb04483915d4f2cd8ac**
AiResult	string	The AI analysis results.	Clip splitting or smart tag information
Usage	string	The token usage. This parameter is returned only for keyword expansion jobs.	{"total_tokens":100}
MediaUrl	string
State	string	The status of the job. Valid values: Finished : The job was successful. Failed : The job failed. Executing : The job is in progress. Created : The job is created and is waiting to be scheduled.	Finished
UserData	string	The custom user data.	{"user":"data"}
SmartJobInfo	object	The information about the smart job.
Title	string	The title of the job.	Test Title
Description	string	The description of the job.	Test Description
UserId	string	The ID of the user.	1974526429******
InputConfig	object	The input configuration.
InputFile	string	The Object Storage Service (OSS) URL of the input file, or the ID of the media asset in the media library.	oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or ****11-DB8D-4A9A-875B-275798****
OutputConfig	object	The output configuration.
Bucket	string	The destination OSS bucket.	test-bucket
Object	string	The path of the destination OSS object.	test-object
CreateTime	string	The time when the job was created. The time is in UTC and formatted based on the ISO 8601 standard.	2020-12-26T04:11:10Z
ModifiedTime	string	The time when the job was last modified. The time is in UTC and formatted based on the ISO 8601 standard.	2020-12-26T04:11:10Z
JobType	string	The type of the job.	ASR
ErrorCode	string	The error code that is returned if the job fails.
ErrorMessage	string	The error message that is returned if the job fails.

The format of a Job Result depends on the Smart Job type. The following samples show the response format for each.

ASR intelligent subtitling

{
  "RequestId": "******2D-443C-5043-B0E4-867070******",
  "JobId": "******042d5e4db6866f6289d1******",
  "State": "Finished",
  "SmartJobInfo": {
    "JobType": "ASR",
    "ModifiedTime": "2022-01-21T06:15:08Z",
    "CreateTime": "2022-01-21T06:15:02Z",
    "Title": "default_title_2022-01-21T06:15:02Z",
    "InputConfig": {
      "JobParameters": "{\"duration\":\"00:30:00\",\"start_time\":\"00:00:00\",\"request_params\":\"&enable_word_level_result=true\"}",
      "InputFile": "oss://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4"
    }
  },
  "JobResult": {
    "AiResult": "[{\"content\":\"Speaking of which,\",\"from\":0.0,\"to\":0.846},{\"content\":\"they are incredibly popular right now.\",\"from\":0.846,\"to\":3.386},{\"content\":\"Tickets are often expensive,\",\"from\":3.386,\"to\":4.402},{\"content\":\"but they sell out instantly.\",\"from\":4.402,\"to\":6.265},{\"content\":\"They have also appeared on various comedy shows to critique new performers.\",\"from\":6.265,\"to\":10.33}]"
  }
}

Text-to-speech

{
  "RequestId": "******2D-443C-5043-B0E4-867070******",
  "JobId": "******042d5e4db6866f6289d1******",
  "State": "Finished",
  "SmartJobInfo": {
    "Title": "default_title_2022-01-21T06:15:07Z",
    "JobType": "TextToSpeech",
    "CreateTime": "2022-01-21T06:15:07Z",
    "ModifiedTime": "2022-01-21T06:15:07Z",
    "InputConfig": {
      "InputFile": "Speaking of which, they are incredibly popular right now. Tickets are often expensive but sell out instantly. They have also appeared on various comedy shows to critique new performers."
    },
    "EditingConfig": "{\"format\":\"MP3\",\"pitch_rate\":0,\"sample_rate\":16000,\"speech_rate\":0,\"voice\":\"Siqi\",\"volume\":50}",
    "OutputConfig": {
      "Bucket": "your-bucket",
      "Object": "your-audio"
    }
  },
  "JobResult": {
    "MediaId": "******bf47c94e82b3b2014361******",
    "AiResult": "[{\"content\":\"Speaking of which,\",\"from\":0.0,\"to\":0.846},{\"content\":\"they are incredibly popular right now.\",\"from\":0.846,\"to\":3.386},{\"content\":\"Tickets are often expensive,\",\"from\":3.386,\"to\":4.402},{\"content\":\"but they sell out instantly.\",\"from\":4.402,\"to\":6.265},{\"content\":\"They have also appeared on various comedy shows to critique new performers.\",\"from\":6.265,\"to\":10.33}]"
  }
}

Text generation

{
	"RequestId":"******AC-5A01-1116-87A4-BF86F2******",
	"UserData":"{\"NotifyAddress\":\"https://****\"}",
	"JobResult":{
		"AiResult":"[\"Our new shop's cakes are made with pure dairy cream, offering a rich, silky-smooth texture. Every bite is a sweet surprise, letting your taste buds dance with freshness and purity!\",\"Explore a new world of desserts. Our new shop's cakes feature premium dairy cream, are lightly sweetened, not heavy, and have rich layers. Each cake tells a unique story of craftsmanship and sweetness, waiting for you to savor.\",\"For those who appreciate the finer things in life, our newly opened cake shop carefully selects dairy cream and rejects artificial additives. Enjoy the pure, milky aroma and a light, delicate texture. Every bite is a unique celebration of the good life.\"]",
    "Usage": "{\"total_tokens\":200}"
	},
	"State":"Finished",
	"JobId":"******8c784f461db57c99c9d9******",
	"SmartJobInfo":{
		"JobType":"TextGenerate",
		"ModifiedTime":"2024-01-17T08:46:17Z",
		"CreateTime":"2024-01-17T08:46:17Z",
		"Title":"default_title_2024-01-17T08:46:17Z",
		"EditingConfig":"{\"Type\":\"MarketingCopy\",\"GenerateConfig\":\"{\\\"keywords\\\":\\\"new shop's cake, dairy cream\\\",\\\"textLength\\\":100,\\\"targetCount\\\":3}\"}"
	}
}

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****",
  "Output": "{}",
  "JobResult": {
    "MediaId": "****20b48fb04483915d4f2cd8ac****",
    "AiResult": "Clip segmentation or AI taggingInformation",
    "Usage": "{\"total_tokens\":100}",
    "MediaUrl": ""
  },
  "State": "Finished",
  "UserData": "{\"user\":\"data\"}",
  "SmartJobInfo": {
    "Title": "Test Title",
    "Description": "Test Description",
    "UserId": "1974526429******",
    "InputConfig": {
      "InputFile": "oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 or ******11-DB8D-4A9A-875B-275798******"
    },
    "OutputConfig": {
      "Bucket": "test-bucket",
      "Object": "test-object"
    },
    "CreateTime": "2020-12-26T04:11:10Z",
    "ModifiedTime": "2020-12-26T04:11:10Z",
    "JobType": "ASR"
  },
  "ErrorCode": "",
  "ErrorMessage": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.