All Products
Search

This Product

    ApsaraVideo VOD:GetAITemplate

    Document Center

    ApsaraVideo VOD:GetAITemplate

    Last Updated:Jul 21, 2026

    Queries an AI template.

    Operation description

    • Currently, this operation is supported in the following regions: China (Beijing), China (Shanghai), and Singapore.

    • Obtain the AI template ID first, and then call this operation to query the configuration information of the AI 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

    vod:GetAITemplate

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TemplateId

    string

    Yes

    The AI template ID. You can obtain the ID by using one of the following methods:

    • When you call the AddAITemplate operation to add an AI template, the AI template ID is the value of the TemplateId parameter in the response.

    • After the AI template is added, you can call the ListAITemplate operation to query the AI template ID, which is the value of the TemplateId parameter in the response.

    1706a0063dd733f6a823ef32e0a5****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    080DA371-8AC0-4CD4-4476-33E64282****
    TemplateInfo

    object

    The information about the AI template.

    CreationTime

    string

    The time when the AI template was created. The time is displayed in ISO 8601 format in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.

    2020-07-08T06:50:45Z
    IsDefault

    string

    Indicates whether the AI template is the default template. Valid values:

    • Default: The template is the default template.

    • NotDefault: The template is not the default template.

    NotDefault
    TemplateType

    string

    The templatetype of the AI template. Valid values:

    • AIMediaAudit: automated review.

    • AIImage: smart thumbnail.

    AIMediaAudit
    TemplateConfig

    string

    The detailed configuration of the AI template. The value is a JSON string. For more information, see AITemplateConfig.

    {"AuditRange":["text-title","video"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"yes"}
    TemplateName

    string

    The name of the AI template.

    DemoAITemplate
    Source

    string

    The source of the AI template. Valid values:

    • System: system.

    • Custom: custom.

    Custom
    TemplateId

    string

    The AI template ID.

    1706a0063dd733f6a823ef32e0a5****
    ModifyTime

    string

    The time when the AI template was last modified. The time is displayed in ISO 8601 format in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.

    2020-07-08T06:58:45Z

    Examples

    Success response

    JSON format

    {
  "RequestId": "080DA371-8AC0-4CD4-4476-33E64282****",
  "TemplateInfo": {
    "CreationTime": "2020-07-08T06:50:45Z",
    "IsDefault": "NotDefault",
    "TemplateType": "AIMediaAudit",
    "TemplateConfig": "{\"AuditRange\":[\"text-title\",\"video\"],\"AuditContent\":[\"screen\"],\"AuditItem\":[\"terrorism\",\"porn\"],\"AuditAutoBlock\":\"yes\"}",
    "TemplateName": "DemoAITemplate",
    "Source": "Custom",
    "TemplateId": "1706a0063dd733f6a823ef32e0a5****",
    "ModifyTime": "2020-07-08T06:58:45Z"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.