创建一个新的Agent会话并返回会话ID。
接口说明
请求说明
该接口用于创建一个新的 Agent 会话。
通过
_meta.agent.agentName指定绑定的 Agent 名称，这是必填项。可以通过
_meta.config.sessionSource透传会话来源标识，便于后续按来源检索。支持通过
_meta.config.sessionTags[].sessionTagCode传入会话标签。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Jsonrpc |
string |
否 |
JSON-RPC 版本，固定 2.0 |
2.0 |
| Id |
string |
否 |
请求方传入的 id，原样回显 |
4758330557805415712 |
| Params |
object |
否 |
业务参数 |
|
| Meta |
object |
否 |
扩展元信息，承载 agent 绑定、会话来源、标签等 |
|
| Agent |
object |
否 |
该会话运行的 Agent 配置，取值范围是 ListAgents 接口返回的结果 |
|
| AgentName |
string |
否 |
会话绑定的 Agent 名称，必填 |
chat_cli_chatbi |
| Config |
object |
否 |
Session 配置参数，比如基于 Session 来源、Session Tag 的过滤参数配置 |
|
| SessionSource |
string |
否 |
会话来源标识，便于按来源检索。比如 Agent 可以在 A 页面使用，也可以在 B 页面进行使用，此时如果有需求需要在 A 页面只展示 A 页面创建出来的 Session，就可以基于该参数进行过滤。长度不超过 128 位，支持英文字母+数字+中划线+下划线组合。 |
openapi_sdk |
| SessionTags |
array<object> |
否 |
会话标签列表，后续可以基于会话标签进行搜索过滤。 |
|
|
object |
否 |
|||
| SessionTagCode |
string |
否 |
会话标签。可以基于会话标签进行过滤，比如调用 OpenAPI 的时候用的是固定的 RAM 子账号，但是调用系统中有自己的账号体系，此时需要基于账号 ID 过滤 Session 列表，该标签就可以传调用系统的账号 ID。长度不超过 128 位，支持英文字母+数字+中划线+下划线组合。 |
chatbi |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数（result） |
||
| RequestId |
string |
Id of the request |
8A9D5E6C-5817-5837-9715-6E3967EC6123 |
| JsonRpcResponse |
object |
JSON-PRC 的返回结果 |
|
| Jsonrpc |
string |
JSON-RPC 版本，固定 2.0 |
2.0 |
| Id |
string |
请求方传入的 id，原样回显 |
1 |
| Result |
object |
业务数据；出错时为 null |
|
| SessionId |
string |
新建的会话 ID |
sess_0f12abc34 |
示例
正常返回示例
JSON格式
{
"RequestId": "8A9D5E6C-5817-5837-9715-6E3967EC6123",
"JsonRpcResponse": {
"Jsonrpc": "2.0",
"Id": "1",
"Result": {
"SessionId": "sess_0f12abc34"
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。