AddTemplate-Intelligent Media Services(IMS)-阿里云帮助中心

Creates a template. Intelligent media production supports the video clip feature based on common and advanced templates, and you can invoke AddTemplate to create a template.

Operation description

Usage notes

To use common templates, refer to Quick start for common templates.
To use advanced templates, refer to Create and use advanced templates.

Limits

After an advanced template is created, it requires parsing time. During this period, the template status is Processing and the template is unavailable. You can use the template only when its status changes to Available. The parsing time depends on the template file size and typically ranges from 10 seconds to 5 minutes.

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:AddTemplate

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The custom template name.	TemplateName
Type	string	No	The templatetype. Valid values: Timeline: common template. Created based on the timeline of a video clip project, where multiple materials are spliced across multiple layers. It supports effects such as text-and-image-to-video conversion, photo albums, opening and ending credits, and default watermarks. VETemplate: advanced template. Created based on Adobe After Effects (AE) effects to achieve advanced media effects with complex animation styles. BatchEditing: one-click video generation template. Supports configuring parameters such as sticker watermarks, background music, background images, voiceover subtitle styles, title subtitle styles, and output resolution. These parameters are automatically applied when a one-click video generation node is committed. Valid values: Timeline : Common template. VETemplate : Advanced template.	Timeline
Config	string	No	The Config of a common template is an encapsulation based on the cloud editing timeline. A custom template Config provides more flexibility. If you have specific requirements, familiarize yourself with the Config structure and customize the template. For more information, see Config details for common templates. For more template Config examples, see Common Config examples for common templates. For the Config configuration of a one-click video generation template, see Metric description of configuration parameters for one-click video generation templates.	See Config documentation
CoverUrl	string	No	The template cover.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
PreviewMedia	string	No	The media ID of the template preview video.	**01bf24bf41c78b2754cb3187**
Status	string	No	The template status. Valid values: Available: Normal. Created: Created but unavailable. Uploading: Uploading. Processing: The advanced template is being analyzed. UploadFailed: Upload failed. ProcessFailed: Advanced template analysis failed. Valid values: UploadFailed : Upload failed. ProcessFailed : Advanced template analysis failed. Available : Normal. Uploading : Uploading. Created : Created but unavailable. Processing : Advanced template analysis in progress.	Available
Source	string	No	The template creation source. Valid values: OpenAPI: Created through OpenAPI. AliyunConsole: Created in the Alibaba Cloud Management Console. WebSDK: Created through WebSDK. Valid values: AliyunConsole : Created in the Alibaba Cloud Management Console. WebSDK : Created through WebSDK. OpenAPI : Created through OpenAPI.	OpenAPI
RelatedMediaids	string	No	The materials associated with the template, used by the common template editor.	{"video":["1805a0c6ca544fb395a06ca683619655"]}

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	**2876-6263-4B75-8F2C-CD0F7FCF**
Template	object	The template information.
TemplateId	string	The template ID.	**01bf24bf41c78b2754cb3187**
Name	string	The template name.	TemplateName
Type	string	The templatetype. Valid values: Timeline : Common template. VETemplate : Advanced template.	Timeline
Config	string	The Timeline template Config documentation.	See Config documentation
CoverUrl	string	The template cover.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
PreviewMedia	string	The media ID of the preview video.	**01bf24bf41c78b2754cb3187**
Status	string	The template status. Valid values: UploadFailed : Upload failed. ProcessFailed : Advanced template analysis failed. Available : Normal. Uploading : Uploading. Created : Created but unavailable. Processing : Advanced template analysis in progress.	Available
CreateSource	string	The template creation source. Valid values: AliyunConsole : Created in the Alibaba Cloud Management Console. WebSDK : Created through WebSDK. OpenAPI : Created through OpenAPI.	OpenAPI
ModifiedSource	string	The template modification source. Valid values: AliyunConsole : Created in the Alibaba Cloud Management Console. WebSDK : Created through WebSDK. OpenAPI : Created through OpenAPI.	OpenAPI

Examples

Success response

JSON format

{
  "RequestId": "****2876-6263-4B75-8F2C-CD0F7FCF****",
  "Template": {
    "TemplateId": "****01bf24bf41c78b2754cb3187****",
    "Name": "TemplateName",
    "Type": "Timeline",
    "Config": "See Config documentation",
    "CoverUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg",
    "PreviewMedia": "****01bf24bf41c78b2754cb3187****",
    "Status": "Available",
    "CreateSource": "OpenAPI",
    "ModifiedSource": "OpenAPI"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.