CreateAsrHotwords
Last updated: 2025-12-02 14:26:57Download PDF
1. API Description
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to create a smart subtitle hotword lexicon.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateAsrHotwords. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Type | Yes | Integer | 0: temporary hotword; 1 file-based hotword. |
| Name | Yes | String | Hotword lexicon name. |
| Content | No | String | Hotword lexicon text. This field is required if Type is set to 0. |
| FileContent | No | String | Base64-encoded content of the hotword file. This field is required if Type is set to 1. |
| FileName | No | String | Name of the uploaded file. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| HotwordsId | String | Hotword lexicon ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 CreateAsrHotwordsExample
Input Example
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAsrHotwords
<Common request parameters>
{
"Type": 0,
"Name": "HotwordsNameExample",
"Content": "Tencent Cloud|10,Automatic Speech Recognition|5,ASR|10"
}Output Example
{
"Response": {
"HotwordsId": "hwd-aexxxxxxxxxxxxxx1481",
"RequestId": "1ebaa15b-14b5-480c-9904-ec90c536e701"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.AccessDBError | Data error. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.HotwordsFormatError | Hot word vocabulary format error. see the hot word configuration instruction document (https://intl.cloud.tencent.com/document/product/862/116244?from_cn_redirect=1#afc37e17-2786-4289-9bc3-8e24435d3f45). |
| InvalidParameterValue.InputInfo | Incorrect input parameters. |
| LimitExceeded.TooMuchHotWords | The number of created hotword lexicons has reached the default upper limit. |
| LimitExceeded.TooMuchLargeHotWords | The number of created large hotword lexicons has reached the upper limit. |