1. 接口描述
接口请求域名： clb.tencentcloudapi.com 。
创建 BYOK 模型
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateModel。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。 |
| AccessType | 是 | String | 接入类型：PublicBYOK/PublicCustom/PrivateCustom 示例值：PrivateCustom |
| ModelProvider | 否 | String | 模型提供商 示例值：openai |
| ModelIds.N | 否 | Array of ModelItem | 通用模型标识列表 |
| Keys.N | 否 | Array of KeyItem | Key 列表 |
| ServiceProviderId | 否 | String | BYOK ID(在自定义模型时在部署网络后必须填写) 示例值：byok-fqn7vwbl |
| ServiceProviderName | 否 | String | 服务供应商(创建BYOK自定义名称)。 示例值：custom |
| Protocol | 否 | String | 模型协议 示例值：openai |
| ApiBase | 否 | String | API Base URL 示例值：http://127.0.0.1:8080 |
| VpcId | 否 | String | VPC ID 示例值：vpc-j5bxoqef |
| SubnetId | 否 | String | 子网 ID 示例值：subnet-60enc8ny |
| HostHeader | 否 | String | 转发请求时添加的Host请求头 示例值：www.a.com |
| Tags.N | 否 | Array of TagInfo | 标签信息 |
| VerifySSL | 否 | Boolean | 是否校验服务提供商的SSL证书 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ServiceProviderId | String | 服务供应商ID 示例值：byok-d4yf0jkd |
| KeyIds | Array of String | 生成的 Key ID 列表 示例值：["mkey-ec5ukd0r"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建BYOK模型
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateModel
<公共请求参数>
{
"AccessType": "PrivateCustom",
"ModelIds": [
{
"ModelId": "gpt-4o",
"ModelAlias": "2rasd"
}
],
"Keys": [
{
"ApiKey": "sk-test-openai-key-003",
"Name": "test-key-5"
}
],
"ModelProvider": "openai",
"ServiceProviderName": "custom",
"ApiBase": "http://127.0.0.1:8080",
"VpcId": "vpc-j5bxoqef",
"SubnetId": "subnet-60enc8ny",
"HostHeader": "www.a.com",
"Tags": [
{
"TagKey": "ekkocao",
"TagValue": "t3"
}
]
}输出示例
{
"Response": {
"KeyIds": [
"mkey-ec5ukd0r"
],
"ServiceProviderId": "byok-d4yf0jkd",
"RequestId": "65f4eb1b-14a8-401a-86c3-3394d1ee96cd"
}
}示例2 创建仅支持文本输入的byok实例
创建仅支持文本输入的byok实例
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateModel
<公共请求参数>
{
"AccessType": "PublicCustom",
"ModelProvider": "openai",
"ModelIds": [
{
"ModelId": "gpt-4o",
"ModelAlias": "my-gpt-4o",
"InputModalities": [
"text"
]
}
],
"Keys": [
{
"ApiKey": "sk-111111111",
"Name": "sk-1"
}
],
"ApiBase": "http://11.141.93.26:10000/v1",
"Tags": [
{
"TagKey": "text",
"TagValue": "text"
}
]
}输出示例
{
"Response": {
"KeyIds": [
"mkey-qd6kwrnt"
],
"ServiceProviderId": "byok-lfwolo91",
"RequestId": "ff11ef23-44dc-45d5-88d2-5ca2f2338380"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InputModality | 多模态能力标签取值不合规。 |
