Call GetBatchMediaProducingJob to query a quick video production job - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Queries detailed information about a batch Intelligent One-Click Video Editing job, including input parameters, job status, and the IDs and URLs of generated media assets. Only job data from 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:GetBatchMediaProducingJob

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the quick video production job.	**b4549d46c88681030f6e**

Response elements

Element	Type	Description	Example
	object	Response parameters.
RequestId	string	The request ID.	**36-3C1E-4417-BDB2-1E034F**
EditingBatchJob	object	The quick video production job details.
JobId	string	The job ID.	**b6b2750d4308892ac3330238**
InputConfig	string	Input configurations. For more information, see InputConfig.	{ "MediaGroupArray": [{ "GroupName": "MediaGroup1", "MediaArray": [ "**9d46c886b45481030f6e", "6c886b4549d481030f6e" ] }, { "GroupName": "MediaGroup2", "MediaArray": [ "d46c886810b454930f6e", "4549d886810b46c30f6e**" ] }], "TitleArray": [ "Huilongguan Hema Fresh has opened", "Hema Fresh has opened" ], "SpeechTextArray": [ "A new Hema Fresh store has opened in the nearby shopping mall,Today is the first day of opening" "There are quite a few people in the mall,Snacks,drinks are relatively cheap. Everyone come and check it out" ] }
EditingConfig	string	Editing configurations. For more information, see EditingConfig.	{ "MediaConfig": { "Volume": 0 }, "SpeechConfig": { "Volume": 1 }, "BackgroundMusicConfig": { "Volume": 0.3 } }
OutputConfig	string	Output configurations. For more information, see OutputConfig.	{ "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4", "Count": 20, "MaxDuration": 15, "Width": 1080, "Height": 1920, "Video": {"Crf": 27} }
Status	string	Job state. Valid values: Init: The job is initialized. Processing: The job is in progress. Finished: The job is complete.	Finished
UserData	string	User-defined data, including business and callback configurations. For more information, see UserData.	{"NotifyAddress":"http://xx.xx.xxx"}
Extend	string	Extended information. Contains the following fields: ErrorCode: the error code of the main job. ErrorMessage: the error message of the main job.	{ "ErrorCode": "InvalidMaterial.NotFound", "ErrorMessage": "The specified clips id not found:[\"**30d0b5e871eebb2ff7f6c75a**\"]" }
CreateTime	string	Time when the job was created, in the ISO 8601 yyyy-MM-ddTHH:mm:ssZ format (UTC).	2024-06-13T08:47:07Z
ModifiedTime	string	Time when the job was last modified. Format: ISO 8601 yyyy-MM-ddTHH:mm:ssZ (UTC).	2024-06-13T08:57:07Z
CompleteTime	string	Time when the job was completed. Format: ISO 8601 yyyy-MM-ddTHH:mm:ssZ (UTC).	2024-06-13T08:57:07Z
JobType	string	Task Type: Script (Script-based automated video editing) Smart_Mix (Intelligent text-to-media matching for video editing) Sports_Highlights (Sporting event highlights compilation) Screen_Media_Highlights (High-energy multi-media mashup editing) Smart_Mix_Media_Select (Intelligent matching – Material selection) Smart_Mix_Timeline_Organize (Intelligent matching – Timeline orchestration) Screen_Media_Highlights_Media_Select (High-energy mashup – Material selection) Screen_Media_Highlights_Timeline_Organize (High-energy mashup – Timeline orchestration) Scene_Batch_Editing (Batch synthesis across multiple timelines)	Script
SubJobList	array<object>	Quick video production subjobs.
	object	Quick video production subjob details.
MediaId	string	The ID of the output media asset.	**1470b11171ee9d19e7e6c66a**
JobId	string	The subjob ID.	**8e81933d44e3ae69e2f81485**
MediaURL	string	The URL of the output file.	http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4
Status	string	Subjob state. Valid values: Init: The subjob is initialized. Processing: The subjob is in progress. Success: The subjob is successful. Failed: The subjob failed.	Success
ErrorCode	string	Error code returned when the subjob fails. Not returned for successful subjobs.	InvalidMaterial.NotFound
ErrorMessage	string	Error message returned when the subjob fails. Not returned for successful subjobs.	The specified clips id not found:["**30d0b5e871eebb2ff7f6c75a**"]
ProjectId	string	The ID of the online editing project.	**7cc47fe04eaa81bd853acb6a**
Duration	number	Duration of the output video, in seconds.	24.5
ExtendInput	string	Additional input. When JobType is Smart_Mix_Timeline_Organize or Screen_Media_Highlights_Timeline_Organize, the additional input is the material selection result. When JobType is Scene_Batch_Editing, the additional input is a list of video editing project IDs.	["**7cc47fe04eaa81bd853acb6a", "04eaa7cc47fe81bd853acb6a**"]
ExtendOutput	string	Additional outputs. When JobType is Smart_Mix_Media_Select or Screen_Media_Highlights_Media_Select, material selection results are additionally returned.	{ "textMatchMediaOutputList": [{ "textMatchMediaSentenceOutputList": [{ "duration": 3.366667, "matchClipList": [{ "clipId": "null-2", "endTime": 11.16, "mediaId": "**a0900f5071efbf1ce7e6c66a", "score": -0.253, "startTime": 8.04 }], "text": "A new Hema Fresh store has opened in the nearby shopping mall", "textId": "0" }, { "duration": 1.566667, "matchClipList": [{ "clipId": "null-1", "endTime": 1.54, "mediaId": "a0900f5071efbf1ce7e6c66a**", "score": -0.2326, "startTime": 0 }], "text": "Today is the first day of opening", "textId": "0" } ] }] }

Examples

Success response

JSON format

{
  "RequestId": "****36-3C1E-4417-BDB2-1E034F****",
  "EditingBatchJob": {
    "JobId": "****b6b2750d4308892ac3330238****",
    "InputConfig": "{\n  \"MediaGroupArray\": [{\n      \"GroupName\": \"MediaGroup1\",\n      \"MediaArray\": [\n        \"****9d46c886b45481030f6e****\",\n        \"****6c886b4549d481030f6e****\" ]\n    }, {\n      \"GroupName\": \"MediaGroup2\",\n      \"MediaArray\": [\n        \"****d46c886810b454930f6e****\",\n        \"****4549d886810b46c30f6e****\" ]\n  }],\n  \"TitleArray\": [\n      \"Huilongguan Hema Fresh has opened\",\n      \"Hema Fresh has opened\" ],\n  \"SpeechTextArray\": [\n      \"A new Hema Fresh store has opened in the nearby shopping mall,Today is the first day of opening\"\n      \"There are quite a few people in the mall,Snacks,drinks are relatively cheap. Everyone come and check it out\" ]\n}",
    "EditingConfig": "{\n  \"MediaConfig\": {\n      \"Volume\": 0\n  },\n  \"SpeechConfig\": {\n      \"Volume\": 1\n  },\n \"BackgroundMusicConfig\": {\n      \"Volume\": 0.3\n  }\n}",
    "OutputConfig": "{\n  \"MediaURL\": \"http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4\",\n  \"Count\": 20,\n  \"MaxDuration\": 15,\n  \"Width\": 1080,\n  \"Height\": 1920,\n  \"Video\": {\"Crf\": 27}\n}",
    "Status": "Finished",
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}",
    "Extend": "{\n\t\"ErrorCode\": \"InvalidMaterial.NotFound\",\n\t\"ErrorMessage\": \"The specified clips id not found:[\\\"****30d0b5e871eebb2ff7f6c75a****\\\"]\"\n}",
    "CreateTime": "2024-06-13T08:47:07Z",
    "ModifiedTime": "2024-06-13T08:57:07Z\n",
    "CompleteTime": "2024-06-13T08:57:07Z\n",
    "JobType": "Script",
    "SubJobList": [
      {
        "MediaId": "****1470b11171ee9d19e7e6c66a****",
        "JobId": "****8e81933d44e3ae69e2f81485****",
        "MediaURL": "http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4",
        "Status": "Success",
        "ErrorCode": "InvalidMaterial.NotFound",
        "ErrorMessage": "The specified clips id not found:[\"****30d0b5e871eebb2ff7f6c75a****\"]",
        "ProjectId": "****7cc47fe04eaa81bd853acb6a****",
        "Duration": 24.5
      }
    ],
    "ExtendInput": "[\"****7cc47fe04eaa81bd853acb6a****\", \"****04eaa7cc47fe81bd853acb6a****\"]",
    "ExtendOutput": "{\n\t\"textMatchMediaOutputList\": [{\n\t\t\"textMatchMediaSentenceOutputList\": [{\n\t\t\t\t\"duration\": 3.366667,\n\t\t\t\t\"matchClipList\": [{\n\t\t\t\t\t\"clipId\": \"null-2\",\n\t\t\t\t\t\"endTime\": 11.16,\n\t\t\t\t\t\"mediaId\": \"****a0900f5071efbf1ce7e6c66a****\",\n\t\t\t\t\t\"score\": -0.253,\n\t\t\t\t\t\"startTime\": 8.04\n\t\t\t\t}],\n\t\t\t\t\"text\": \"A new Hema Fresh store has opened in the nearby shopping mall\",\n\t\t\t\t\"textId\": \"0\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"duration\": 1.566667,\n\t\t\t\t\"matchClipList\": [{\n\t\t\t\t\t\"clipId\": \"null-1\",\n\t\t\t\t\t\"endTime\": 1.54,\n\t\t\t\t\t\"mediaId\": \"****a0900f5071efbf1ce7e6c66a****\",\n\t\t\t\t\t\"score\": -0.2326,\n\t\t\t\t\t\"startTime\": 0\n\t\t\t\t}],\n\t\t\t\t\"text\": \"Today is the first day of opening\",\n\t\t\t\t\"textId\": \"0\"\n\t\t\t}\n\t\t]\n\t}]\n}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.