CreateCopilotSession - 创建会话

更新时间:
复制 MD 格式

创建 Copilot 会话

接口说明

  • 本接口仅创建会话,不发送消息,也不触发 Agent 执行。

  • 创建成功后,使用返回的 sessionId 调用 GenerateCopilotStreamResponse 发送消息。

  • 会话 ID 由服务端生成,不支持调用方指定。

  • 每次成功调用均创建一个独立会话。本接口不提供客户端幂等参数,重复调用可能创建多个会话。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sysom:CreateCopilotSession

create

*全部资源

*

无 无

请求语法

POST /api/v1/copilot/sessions HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

否

请求 Body

name

string

否

会话名称。长度为 1~255 个字符。默认值为 New Session。不支持空字符串或 null。未指定名称时,服务端在受理首条用户消息时,根据消息内容生成会话名称。

排查 CPU 负载

返回参数

名称

类型

描述

示例值

object

requestId

string

请求 ID,可用于全链路诊断。

5BC79EF5-798B-5499-9683-4E14EBBBF712

code

string

错误码

Success

message

string

错误信息

  • 如果 code == Success,则本字段为空;

  • 否则本字段包含请求错误信息。

""

data

object

返回数据。

sessionId

string

会话 ID。后续发送消息、查询、更新或删除会话时使用该值。

c356bc310e4345c3a602a2912322ad21

name

string

会话名称。未指定时为 New Session。

排查 CPU 负载

status

string

会话状态。本接口创建的会话为 active,表示会话可使用,不表示 Agent 正在执行任务。

枚举值:

  • active
  • archived

active

activeTurn

object

当前活动执行信息。

turnId

string

执行 ID。提交用户输入、重连事件流或停止执行时使用该值。

d71fc5ceac2949f39a264c8a585f3148

status

string

执行状态。

running

pendingInputId

string

当前等待用户填写的表单 ID。提交用户输入时使用该值;无待提交表单时为 null。

form-001

inputTokens

integer

本次执行累计消耗的输入 Token 数。

1200

outputTokens

integer

本次执行累计生成的输出 Token 数。

80

createdAt

string

执行创建时间。采用 ISO 8601 格式,包含时区偏移。

2026-10-29T10:01:00+08:00

updatedAt

string

执行更新时间。采用 ISO 8601 格式,包含时区偏移。

2026-10-29T10:01:30+08:00

finishedAt

string

执行结束时间。采用 ISO 8601 格式,包含时区偏移。尚未结束时为 null。

2026-10-29T10:02:00+08:00

cursor

string

会话最新持久化事件的游标。新建会话尚无事件,返回 "0"。该字段为十进制字符串。

0

createdAt

string

创建时间。

2026-10-29T10:00:00+08:00

updatedAt

string

更新时间

2026-10-29T10:00:00+08:00

lastTurn

object

最近一次执行信息。

turnId

string

执行 ID。

d71fc5ceac2949f39a264c8a585f3148

status

string

执行状态。

completed

pendingInputId

string

当前等待用户填写的表单 ID。

form-001

createdAt

string

执行创建时间。采用 ISO 8601 格式,包含时区偏移。

2026-10-29T10:01:00+08:00

updatedAt

string

执行更新时间。采用 ISO 8601 格式,包含时区偏移。

2026-10-29T10:01:00+08:00

finishedAt

string

执行结束时间。采用 ISO 8601 格式,包含时区偏移。尚未结束时为 null。

2026-10-29T10:01:00+08:00

inputTokens

integer

本次执行累计消耗的输入 Token 数。

1200

outputTokens

integer

本次执行累计消耗的输出 Token 数。

80

sessionType

string

会话来源。取值:openapi,主动调用;cron,定时任务;im_dingtalk,钉钉;im_feishu,飞书;alert,告警。本接口创建的会话为 openapi。

openapi

scheduledTask

object

所属定时任务信息

taskId

integer

所属定时任务的 ID。

42

taskName

string

定时任务触发时的任务名称。后续修改任务名称不会改变该值。

每日巡检

runId

string

本次调度执行的 ID,用于区分同一定时任务的不同触发记录。

run-example-001

scheduledAt

string

计划触发时间。采用 ISO 8601 格式,包含时区偏移。

2026-10-29T09:00:00+08:00

startedAt

string

Copilot 开始处理本次调度的时间。采用 ISO 8601 格式,包含时区偏移。

2026-10-29T09:00:00+08:00

timezone

string

定时任务的调度时区。

Asia/Shanghai

示例

正常返回示例

JSON格式

{
  "requestId": "5BC79EF5-798B-5499-9683-4E14EBBBF712\n",
  "code": "Success",
  "message": "\"\"",
  "data": {
    "sessionId": "c356bc310e4345c3a602a2912322ad21",
    "name": "排查 CPU 负载",
    "status": "active",
    "activeTurn": {
      "turnId": "d71fc5ceac2949f39a264c8a585f3148",
      "status": "running",
      "pendingInputId": "form-001",
      "inputTokens": 1200,
      "outputTokens": 80,
      "createdAt": "2026-10-29T10:01:00+08:00",
      "updatedAt": "2026-10-29T10:01:30+08:00",
      "finishedAt": "2026-10-29T10:02:00+08:00"
    },
    "cursor": "0",
    "createdAt": "2026-10-29T10:00:00+08:00\n",
    "updatedAt": "2026-10-29T10:00:00+08:00",
    "lastTurn": {
      "turnId": "d71fc5ceac2949f39a264c8a585f3148",
      "status": "completed",
      "pendingInputId": "form-001",
      "createdAt": "2026-10-29T10:01:00+08:00",
      "updatedAt": "2026-10-29T10:01:00+08:00",
      "finishedAt": "2026-10-29T10:01:00+08:00",
      "inputTokens": 1200,
      "outputTokens": 80
    },
    "sessionType": "openapi",
    "scheduledTask": {
      "taskId": 42,
      "taskName": "每日巡检",
      "runId": "run-example-001",
      "scheduledAt": "2026-10-29T09:00:00+08:00",
      "startedAt": "2026-10-29T09:00:00+08:00",
      "timezone": "Asia/Shanghai"
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。