Use the AddTemplate API to create a template - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Creates a template. Intelligent Cloud Editor supports the video clip feature based on standard templates and advanced templates. You can invoke AddTemplate to create a template.

Operation description

Usage notes

To use standard templates, see Quick start for standard templates.
To use advanced templates, see Create and use advanced templates.

Limits

After an advanced template is created, it takes some time to be parsed. During parsing, the template status is Processing and the template is not active. The template becomes active 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.	Template name
Type	string	No	The templatetype. Valid values: Timeline (standard template): a template created based on the Timeline of a video clip node (multiple materials on multiple tracks are concatenated in sequence). This templatetype can be used to implement effects such as image-to-video conversion, photo albums, intros and outros, and default watermarks. VETemplate (advanced template): a template created based on Adobe After Effects (AE) effects. This templatetype can be used to implement advanced media effects with complex animations. BatchEditing (one-click video production template): supports configurations for sticker watermarks, background music, background images, narration subtitle styles, title subtitle styles, and output resolution parameters. These configurations are automatically applied when you commit a one-click video production node. Valid values: Timeline : Standard template. VETemplate : Advanced template.	Timeline
Config	string	No	The standard template Config is an encapsulation based on the cloud editing Timeline. Custom template Config provides more flexibility. If you have special requirements, familiarize yourself with the Config structure and customize the template. For details, see Standard template Config details. For more template Config examples, see Common standard template Config examples. For one-click video production template Config configurations, see One-click video production template configuration parameter description.	See the Timeline template Config documentation
CoverUrl	string	No	The template cover URL.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
PreviewMedia	string	No	The media asset ID of the template preview video.	**01bf24bf41c78b2754cb3187**
Status	string	No	The template status. Valid values: Available: normal. Created: created but not yet available. Uploading: uploading. Processing: 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 not yet available. Processing : Advanced template is being analyzed.	Available
Source	string	No	The template creation source. Valid values: OpenAPI: created by using OpenAPI. AliyunConsole: created by using the Alibaba Cloud Management Console. WebSDK: created by using WebSDK. Valid values: AliyunConsole : Created by using the Alibaba Cloud Management Console. WebSDK : Created by using WebSDK. OpenAPI : Created by using OpenAPI.	OpenAPI
RelatedMediaids	string	No	The media assets associated with the template, used by the standard 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.	Template name
Type	string	The templatetype. Valid values: Timeline : Standard template. VETemplate : Advanced template.	Timeline
Config	string	See the Timeline template Config documentation.	See the Config documentation
CoverUrl	string	The template cover URL.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
PreviewMedia	string	The media asset 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 not yet available. Processing : Advanced template is being analyzed.	Available
CreateSource	string	The template creation source. Valid values: AliyunConsole : Created by using the Alibaba Cloud Management Console. WebSDK : Created by using WebSDK. OpenAPI : Created by using OpenAPI.	OpenAPI
ModifiedSource	string	The template modification source. Valid values: AliyunConsole : Created by using the Alibaba Cloud Management Console. WebSDK : Created by using WebSDK. OpenAPI : Created by using OpenAPI.	OpenAPI

Examples

Success response

JSON format

{
  "RequestId": "****2876-6263-4B75-8F2C-CD0F7FCF****",
  "Template": {
    "TemplateId": "****01bf24bf41c78b2754cb3187****",
    "Name": "Template name",
    "Type": "Timeline",
    "Config": "参见Config文档",
    "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.