Queries the details of an AI template.

Description

Before you call this operation to query the details of an AI template, you must obtain the ID of the AI template.

QPS limit

You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business can be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limits on API operations in ApsaraVideo VOD.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetAITemplate

The operation that you want to perform. Set the value to GetAITemplate.

TemplateId String Yes 1706a0063dd733f6a823ef32e0a5****

The ID of the AI template. You can use one of the following methods to obtain the ID of the AI template:

  • Call the AddAITemplate operation to add an AI template if no AI template exists. The value of TemplateId from the response is the ID of the AI template.
  • Call the ListAITemplate operation if the template already exists. The value of TemplateId from the response is the ID of the AI template.

Response parameters

Parameter Type Example Description
RequestId String 080DA371-8AC0-4CD4-4476-33E64282****

The ID of the request.

TemplateInfo Object

The information about the AI template.

CreationTime String 2020-07-08T06:50:45Z

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

IsDefault String NotDefault

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

  • Default
  • NotDefault
TemplateType String AIMediaAudit

The type of the AI template. Valid values:

  • AIMediaAudit: automated review
  • AIImage: smart thumbnail
TemplateConfig String {"AuditRange":["text-title","video"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"yes"}

The detailed configurations of the AI template. The value is a JSON string.

TemplateName String DemoAITemplate

The name of the AI template.

Source String Custom

The source of the AI template. Valid values:

  • System
  • Custom
TemplateId String 1706a0063dd733f6a823ef32e0a5****

The ID of the AI template.

ModifyTime String 2020-07-08T06:58:45Z

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

Examples

Sample requests

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetAITemplate
&TemplateId=1706a0063dd733f6a823ef32e0a5****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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

For a list of error codes, visit the API Error Center.