SubmitIProductionJob - Submit an intelligent production job - Alibaba Cloud - ApsaraVideo Media Processing

Submits an intelligent production job.

Operation description

This operation submits jobs for asynchronous execution. The system adds each job to a pipeline for scheduling, queuing, and processing. You can retrieve job results by calling the QueryIProductionJob operation or through asynchronous message notifications.

QPS limit

The QPS limit for this operation is 100 queries per second (QPS) for each user. If you exceed this limit, API calls are subject to rate limiting. For more information, see QPS limits.

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

mts:SubmitIProductionJob

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FunctionName	string	Yes	The name of the function. For information about the regions that support each function, see Service regions. Valid values: VideoH2V: Converts a landscape video to a portrait video. VideoDelogo: Removes watermarks or logos from videos. Cover: Generates an intelligent cover. VideoClip: Generates a video summary. ImageH2V: Converts a landscape image to a portrait image. ImageDelogo: Removes watermarks or logos from images. CaptionExtraction: Performs caption extraction. The algorithm extracts captions from the input video and returns the caption file. VideoDetext: Removes hard-coded subtitles from videos. VideoGreenScreenMatting: Performs green screen matting. The algorithm composites the input green screen video with a background image and returns the resulting video. MusicSegmentDetect: Performs chorus detection. The algorithm detects chorus segments in the input audio or video file and returns their start and end times. If no chorus is detected, the result is empty. AudioMixing: Performs audio mixing. AudioBeatDetection: Performs beat detection. The algorithm takes the URL of an audio or video file as input and outputs a list of beat timestamps (BeatList) and a list of downbeat timestamps (DownBeatList). ImageCartoonize: Applies 3D or stylized effects to faces. To use the face stylization feature, contact us on DingTalk at yuanzhigao1209. AudioQualityAssessment: Assesses audio quality. FaceBeauty: Applies beauty filters to faces in videos. SpeechDenoise: Performs intelligent noise reduction. Note For audio quality assessment, the input audio must be a 16-bit quantized WAV file. Both mono and stereo channels are supported. Supported sampling rates range from 8,000 Hz to 48,000 Hz.	ImageCartoonize
ModelId	string	No	The ID of the algorithm model. If you do not specify this parameter, the system uses the default model for the function.	null
JobParams	string	No	The job parameters for the algorithm, specified as a JSON object. The content of this parameter varies depending on the algorithm. For more information, see Supplemental parameters for intelligent production jobs.	{"Model":"gif"}
ScheduleParams	string	No	Optional job scheduling parameters.	null
NotifyUrl	string	No	The callback URL. Only MNS message queues are supported. You can find the message queue path in the MNS console by navigating to Queues > Details.	mns://125340688170****.mns.cn-beijing.aliyuncs.com/queues/example-pipeline
UserData	string	No	Optional custom data that the service passes back in the callback notification.	{\"key\":\"value\"}
PipelineId	string	No	The ID of the job pipeline. You can obtain the pipeline ID from the MPS console by navigating to Global Settings > Pipelines. This ID determines the job callback queue and provides tenant isolation. If you do not specify this parameter, the default pipeline is used. The default pipeline has a concurrency of 10 and is not bound to a message queue for notifications.	39f8e0bc005e4f309379701645f4****
Input	string	No	The input file in an OSS bucket. Only OSS paths are supported. The file must be in an OSS bucket in the same region as the MPS service. You can obtain the path from the MPS console by navigating to Media Management > Media List, or from the OSS console by selecting the corresponding bucket. Note The `Input` parameter is required for some algorithms. Specify this parameter based on your business requirements.	oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4
Output	string	No	The output file in an OSS bucket. Only OSS paths are supported. The destination OSS bucket must be in the same region as the MPS service. You can obtain the path from the MPS console by navigating to Media Management > Media List, or from the OSS console by selecting the corresponding bucket. Note The format is `oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt`. In this format, `{source}`, `{timestamp}`, and `{sequenceId}` are placeholders. The system replaces them with the input filename, a Unix timestamp, and a sequence number, respectively. The placeholders are not required. However, for algorithms that produce multiple outputs, such as intelligent cover, you must include a sequence number placeholder like `{sequenceId}` to ensure that each output file has a unique path. You can define the file extension.	oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt

Response elements

Element	Type	Description	Example
	object	The returned parameters.
RequestId	string	The request ID.	5210DBB0-E327-4D45-ADBC-0B83C8796E26
JobId	string	The job ID. Save this ID for subsequent queries.	39f8e0bc005e4f309379701645f4****
Result	string	The job result. The structure of the result varies depending on the algorithm. For more information, see Supplemental parameters for intelligent production jobs.	{ "Code":"Success", "Details":[], "FunctionName":"ImageCartoonize", "JobId":"39f8e0bc005e4f309379701645f4****", "Message":"success", "State":"Success", "Type":"IProduction" }

Examples

Success response

JSON format

{
  "RequestId": "5210DBB0-E327-4D45-ADBC-0B83C8796E26",
  "JobId": "39f8e0bc005e4f309379701645f4****",
  "Result": "{ \"Code\":\"Success\", \"Details\":[], \"FunctionName\":\"ImageCartoonize\", \"JobId\":\"39f8e0bc005e4f309379701645f4****\", \"Message\":\"success\", \"State\":\"Success\", \"Type\":\"IProduction\" }"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.