All Products
Search

This Product

    :CreateCustomTemplate

    Document Center

    :CreateCustomTemplate

    Last Updated:Mar 30, 2026

    Creates a custom media processing template.

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

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Name

    string

    Yes

    The template name.

    test-template
    Type

    integer

    Yes

    The template type. Valid values:

    • 1: transcoding template.

    • 2: snapshot template.

    • 3: animated image template.

    • 4. image watermark template.

    • 5: text watermark template.

    • 6: subtitle template.

    • 7: AI-assisted content moderation template.

    • 8: AI-assisted intelligent thumbnail template.

    • 9: AI-assisted intelligent erasure template.

    • 10: AI-assisted media fingerprint analysis template.

    • 11: AI-assisted smart tagging template.

    1
    Subtype

    integer

    No

    The template subtype.

    Valid values for transcoding templates:

    • 1 (Normal): regular template.

    • 2 (AudioTranscode): audio transcoding template.

    • 3 (Remux): container format conversion template.

    • 4 (NarrowBandV1): Narrowband HD 1.0 template.

    • 5 (NarrowBandV2): Narrowband HD 2.0 template.

    Valid values for snapshot templates:

    • 1 (Normal): regular template.

    • 2 (Sprite): sprite template.

    • 3 (WebVtt): WebVTT template.

    Valid values for AI-assisted content moderation templates:

    • 1 (Video): video moderation template.

    • 2 (Audio): audio moderation template.

    • 3 (Image): image moderation template.

    Valid values for AI-assisted intelligent erasure templates.

    • 1 (VideoDelogo): logo erasure template.

    • 2 (VideoDetext): subtitle erasure template.

    1
    TemplateConfig

    string

    Yes

    The template configurations. For more information, see Template parameters.

    {"Container":{"Format":"flv"},"Video":{},"Audio":{}}

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    ******11-DB8D-4A9A-875B-275798******
    CustomTemplate

    object

    The template information.

    TemplateId

    string

    The template ID.

    ****20b48fb04483915d4f2cd8ac****
    TemplateName

    string

    The template name.

    test-template
    Type

    integer

    The type ID of the template.

    1
    TypeName

    string

    The type name of the template.

    TranscodeTemplate
    Subtype

    string

    The subtype name of the template.

    Remux
    Status

    string

    The template state.

    Normal
    IsDefault

    boolean

    Indicates whether the template is the default template.

    true
    TemplateConfig

    string

    The template configurations.

    {"Container":{"Format":"flv"},"Video":{},"Audio":{}}
    CreateTime

    string

    The time when the template was created.

    2022-04-19T02:04:31Z
    ModifiedTime

    string

    The time when the template was last modified.

    2022-04-19T02:04:31Z

    Examples

    Success response

    JSON format

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "CustomTemplate": {
    "TemplateId": "****20b48fb04483915d4f2cd8ac****",
    "TemplateName": "test-template",
    "Type": 1,
    "TypeName": "TranscodeTemplate",
    "Subtype": "Remux",
    "Status": "Normal",
    "IsDefault": true,
    "TemplateConfig": "{\"Container\":{\"Format\":\"flv\"},\"Video\":{},\"Audio\":{}}",
    "CreateTime": "2022-04-19T02:04:31Z",
    "ModifiedTime": "2022-04-19T02:04:31Z"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.