执行会话

1. 接口描述

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

腾讯混元大模型是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。

本接口暂不支持返回图片内容。

默认该接口下单账号限制并发数为 5 路，如您有提高并发限制的需求请购买。

请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “开发者资源 - SDK” 部分提供。

我们推荐您使用 API Explorer，方便快速地在线调试接口和下载各语言的示例代码，点击打开。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：RunThread。
Version	是	String	公共参数，本接口取值：2023-09-01。
Region	否	String	公共参数，此参数为可选参数。
ThreadID	是	String	会话 ID 示例值：thread_OteLtAcmh7prn7tb8uQ3SJzh 取值可参考：创建会话
AssistantID	否	String	助手 ID（目前未使用，留空）示例值：asst_x39o8phGyiIC8llpaVShxVmL
Model	否	String	模型名称，可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro、 hunyuan-code、 hunyuan-role、 hunyuan-functioncall、 hunyuan-vision、 hunyuan-turbo。各模型介绍请阅读产品概述中的说明。注意：不同的模型计费不同，请根据购买指南按需调用。示例值：hunyuan-pro
AdditionalMessages.N	否	Array of ThreadAdditionalMessage	附加消息示例值：[{"Role":"user","Content":"你是谁"}]
Temperature	否	Float	说明：1. 影响模型输出多样性，模型已有默认参数，不传值时使用各模型推荐值，不推荐用户修改。2. 取值区间为 [0.0, 2.0]。较高的数值会使输出更加多样化和不可预测，而较低的数值会使其更加集中和确定。
TopP	否	Float	说明：1. 影响输出文本的多样性。模型已有默认参数，不传值时使用各模型推荐值，不推荐用户修改。2. 取值区间为 [0.0, 1.0]。取值越大，生成文本的多样性越强。
Stream	否	Boolean	是否流式输出，当前只允许 true 示例值：true
MaxPromptTokens	否	Integer	运行过程中可使用的 token 最大数量。示例值：0
MaxCompletionTokens	否	Integer	运行过程中可使用的完成 token 的最大数量。示例值：0
Tools.N	否	Array of Tool	可调用的工具列表，仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。
ToolChoice	否	String	工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-pro、hunyuan-turbo、hunyuan-functioncall 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto 示例值：auto

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。

4. 示例

示例1 执行会话

执行会话

输入示例

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

{
    "ThreadID": "thread_zqkehzQBog4v4lJxBPQRXtYW",
    "Model": "hunyuan-pro",
    "AdditionalMessages": [
        {
            "Role": "user",
            "Content": "你是谁"
        }
    ],
    "Stream": true
}

输出示例

{
    "ID": "run_cRpe4PGgXxTwwvuee55anOO4",
    "Object": "thread.run",
    "CreatedAt": 1727355339,
    "ThreadID": "thread_zqkehzQBog4v4lJxBPQRXtYW",
    "AssistantID": "",
    "Status": "created",
    "RequiredAction": null,
    "LastError": null,
    "ExpiresAt": 0,
    "StartedAt": 0,
    "CancelledAt": 0,
    "FailedAt": 0,
    "CompletedAt": 0,
    "InCompleteDetails": null,
    "Model": "hunyuan",
    "Instructions": "",
    "Tools": [],
    "Metadata": {},
    "Usage": null,
    "Temperature": 0,
    "TopP": 0,
    "MaxPromptTokens": 0,
    "MaxCompletionTokens": 0,
    "TruncationStrategy": {
        "Type": "",
        "LastMessages": null
    },
    "ParallelToolCalls": false,
    "ResponseFormat": null
}

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: GitHub Gitee

Tencent Cloud SDK 3.0 for Java: GitHub Gitee

Tencent Cloud SDK 3.0 for PHP: GitHub Gitee

Tencent Cloud SDK 3.0 for Go: GitHub Gitee

Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee

Tencent Cloud SDK 3.0 for .NET: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.EngineRequestTimeout	引擎层请求超时；请稍后重试。
FailedOperation.EngineServerError	引擎层内部错误；请稍后重试。
FailedOperation.EngineServerLimitExceeded	引擎层请求超过限额；请稍后重试。
FailedOperation.FreeResourcePackExhausted	免费资源包余量已用尽，请购买资源包或开通后付费。
FailedOperation.ResourcePackExhausted	资源包余量已用尽，请购买资源包或开通后付费。
FailedOperation.ServiceNotActivated	服务未开通，请前往控制台申请试用。
FailedOperation.ServiceStop	用户主动停服。
FailedOperation.ServiceStopArrears	欠费停服。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Model	模型不存在。

1. 接口描述#

2. 输入参数#

3. 输出参数#

4. 示例#

示例1 执行会话#

输入示例#

输出示例#

5. 开发者资源#

腾讯云 API 平台#

API Inspector#

SDK#

命令行工具#

6. 错误码#