Domain name for API request: adp.intl.tencentcloudapi.com.
This API is used to modify the knowledge base.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyKB. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| KbId | Yes | String | Knowledge base ID |
| Spec | Yes | KBSpec | Writable attribute (use together with update_mask) |
| UpdateMask | Yes | FieldMask | Field mask: specify the field to be modified (snake-shaped field name). Unlisted fields are ignored |
| ExtendFields | No | KBModifyExtendFields | Scaling operation (for hosting special operations that cannot be categorized into regular field modification, such as triggering over-limit recovery. It is effective only when 'extend_fields' is also input in update_mask. For the value, refer to KBExtendedAction: 1=trigger over-limit recovery) |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
Modify a knowledge base
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyKB
<Common request parameters>
{
"KbId": "2095346479588688512",
"Spec": {
"Description": "Test edit",
"EsConfig": {
"EncryptedPassword": "WG1MFdZ8blowOUfmgYdcRZrN0jUR0qbO2MT4ZkjsNYDkVZra4Y0cA0+BCVe7+mJh07fPBqGn12QivpFACZ7Yt9oALjEMeEznjmW6YKRCwt3AaZ5l6liiCuFhO3x1DfWEr0kTb2acxVGYw40cv5QdivoSu+bLtcF8XATIT3KEeAuUAmBEsd2rWLWpKQAwVCxRSskO3TA2hy+mMtYa8ERLhELn9bDMRahrY2tcLK0Wl+5ji1aZuDBp/4z/KhOLVtpvg87tcd6rGY5WWhIStAgBoQs5XsBHMDZKCDapKWKmpXBLJKViBE9LQhRXDNLRvikwO0v1/pcjmoy++7nFaJAmBQ==",
"InstanceId": "",
"StorageType": 2,
"UserName": ""
},
"ModelConfig": {
"EmbeddingModel": "Youtu/youtu-embedding-llm",
"QaExtractModel": "Deepseek/deepseek-v4-pro"
},
"Name": "Test Edit"
},
"UpdateMask": {
"Paths": [
"name"
]
}
}{
"Response": {
"RequestId": "18174358-c58e-4c2a-baf4-0bfebd539f16"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈