百宝箱开放平台 ✖️ 创建会话

50 阅读1分钟

创建会话

在开放平台, 会话是指用户与智能体的对话过程,可以包含多个轮次的问答。通过调用本接口,开发者可以创建一个新的会话。

前提条件

  • 在调用本接口前,请先完成应用的发布。

请求地址

POST``https://api.tbox.cn/api/conversation/create

请求头

参数名是否必填类型说明示例
AuthorizationString用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理pat_2j4e******THUIVRH1

请求参数

参数名是否必填类型说明示例
appIdString应用 ID,需要通过 API 进行集成的应用 ID。202506e******00450562

请求示例

curl --location 'https://api.tbox.cn/api/conversation/create' \
--header 'Authorization: {your_token}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "appId":{your_appId}
}'

返回参数

参数名类型说明示例
errorCodeString错误码,为 0 表示成功。0
errorMsgString错误信息。success
dataString会话 ID。-
traceIdStringtraceId,用于排查问题0a42******9265

返回示例

成功返回

{
    "data": "2025******3533",
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0a42******9265"
}

失败返回

{
    "errorCode": "P_1_02_084",
    "errorMsg": "app不存在",
    "solution": "请确认参数:appId是否有效"
}