负载均衡聊天补全

1. 接口描述

接口请求域名： clb.tencentcloudapi.com 。

聊天测试，发送聊天请求验证模型连通性。用户传入 ApiKey 和 Model，支持自定义消息和额外参数、支持多模态附件。stream 强制关闭，max_tokens 上限 100。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChatCompletions。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。
ApiKey	否	String	virtual key，用于向代理网关鉴权示例值：sk-3qIbn_4___xKHm6HwjTtncyCpHJD_ddDeB6ytjvpw2fq8G6x_LNO6t11Y_l7qQuKEfVH4t1s1gjUv3_vb2mqTkUv
Attachments.N	否	Array of MultiModalityAttachments	多模态附件列表
ChatContent	否	String	聊天内容示例值：hi
Model	否	String	模型名称，配置的模型标识示例：gpt-4o、deepseek-chat 示例值：gpt-4o-mini-test-connection
ModelRouterId	否	String	模型路由实例ID 示例值：cmr-d4yzkh0o
RequestPath	否	String	请求路径默认值：/v1/chat/completions 示例值：/v1/chat/completions

3. 输出参数

参数名称	类型	描述
ChatResponseMessage	String	聊天的返回信息示例值：[Fake v2] Detected user_text="What's in this image?", images=1, files=0, format=openai-chat
ErrorInChat	String	聊天请求发送过程中的失败信息示例值：HTTP 401 Unauthorized: {"error":{"message":"team not allowed to access model. This team can only access models=['gpt-4.1-nano']. Tried to access kimi-mock","type":"team_model_access_denied","param":"model","code":"401"}}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 pdf输入对话测试

pdf输入对话测试

输入示例

POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChatCompletions
<公共请求参数>

{
    "ApiKey": "sk-3qIbn_4___xKHm6HwjTtncyCpHJD_ddDeB6ytjvpw2fq8G6x_LNO6t11Y_l7qQuKEfVH4t1s1gjUv3_vb2mqTkUv",
    "Model": "gpt-4o-mini-test-connection",
    "RequestPath": "/v1/chat/completions",
    "Attachments": [
        {
            "Type": "pdf",
            "Data": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KL0NvbnRlbnRzIDQgMCBSCi9SZXNvdXJjZXMgPDwvRm9udCA8PC9GMSAyIDAgUj4+Pj4+PgplbmRvYmoKNCAwIG9iago8PC9MZW5ndGggNDQ+PgpzdHJlYW0KQlQKL0YxIDI0IFRmCjEwMCA3MDAgVGQKKHRlc3QpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKMiAwIG9iago8PC9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQovQmFzZUZvbnQgL0hlbHZldGljYT4+CmVuZG9iagoxIDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDE+PgplbmRvYmoKNSAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyAxIDAgUj4+CmVuZG9iagp0cmFpbGVyCjw8L1NpemUgNgovUm9vdCA1IDAgUj4+CnN0YXJ0eHJlZgozMjQKJSVFT0Y="
        }
    ]
}

输出示例

{
    "Response": {
        "ChatResponseMessage": "[Fake v2] Detected user_text=\"What's this file about?\", images=0, files=1, format=openai-chat",
        "RequestId": "cb9c6c5a-ba63-4dd1-a0ac-77f230d49989"
    }
}

示例2 图像输入对话测试

图像输入对话测试

输入示例

POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChatCompletions
<公共请求参数>

{
    "ApiKey": "sk-3qIbn_4___xKHm6HwjTtncyCpHJD_ddDeB6ytjvpw2fq8G6x_LNO6t11Y_l7qQuKEfVH4t1s1gjUv3_vb2mqTkUv",
    "Model": "gpt-4o-mini-test-connection",
    "RequestPath": "/v1/chat/completions",
    "Attachments": [
        {
            "Type": "image",
            "Data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkAAIAAAoAAv/lxKUAAAAASUVORK5CYII="
        }
    ]
}

输出示例

{
    "Response": {
        "ChatResponseMessage": "[Fake v2] Detected user_text=\"What's in this image?\", images=1, files=0, format=openai-chat",
        "RequestId": "34551057-b067-41de-94e2-4604f15d9ab8"
    }
}

示例3 基础对话测试

基础对话测试

输入示例

POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChatCompletions
<公共请求参数>

{
    "ApiKey": "sk-3qIbn_4___xKHm6HwjTtncyCpHJD_ddDeB6ytjvpw2fq8G6x_LNO6t11Y_l7qQuKEfVH4t1s1gjUv3_vb2mqTkUv",
    "Model": "gpt-4o-mini-test-connection",
    "RequestPath": "/v1/messages"
}

输出示例

{
    "Response": {
        "ChatResponseMessage": "[Fake v2] Echo text-only: \"Hi, this is a connectivity test.\"",
        "RequestId": "d5b8b664-f033-4e06-af59-c3a1cae1940e"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.InsufficientBalance	账户余额不足。
FailedOperation.InvalidApiKey	API Key 无效或未授权。请求路径: %(request_path)s
FailedOperation.ModelDoesNotSupportModality	当前模型不支持请求中携带的模态。
FailedOperation.ModelNotFound	模型不存在或访问被拒绝。请求路径: %(request_path)s
FailedOperation.RateLimitExceeded	触发供应商的速率限制。请求路径: %(request_path)s
FailedOperation.RequestTimeout	请求超时，可能由网络问题或模型响应慢导致。请求路径: %(request_path)s
InvalidParameter.AttachmentItem	附件不合规。
InvalidParameter.Attachments	附件不合规。
InvalidParameter.EndpointUnreachable	上游端点不可达或返回错误。访问地址: %(url)s, 状态码: %(status_code)s

聊天补全

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 pdf输入对话测试

输入示例

输出示例

示例2 图像输入对话测试

输入示例

输出示例

示例3 基础对话测试

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码