全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：CreateAgentSession - 创建新会话

    文档中心

    大数据开发治理平台 DataWorks：CreateAgentSession - 创建新会话

    更新时间：Jul 13, 2026

    创建一个新的Agent会话并返回会话ID。

    接口说明

    请求说明

    • 该接口用于创建一个新的 Agent 会话。

    • 通过_meta.agent.agentName指定绑定的 Agent 名称，这是必填项。

      • dataworks_data_agent ： DataWorks 系统内置智能体 (Agent) — Data Agent，覆盖数据集成、开发、运维、治理与分析全链路的智能化数据开发 AI 能力

      • dataworks_chatbi_agent ： DataWorks 系统内置智能体 (Agent) — ChatBI，基于自然语言处理与智能分析技术，通过对话交互实现从需求解析、数据抽取、代码自动生成到可视化报告输出的全流程自动化分析

    • 可以通过_meta.config.sessionSource透传会话来源标识，便于后续按来源检索。

    • 支持通过_meta.config.sessionTags[].sessionTagCode传入会话标签。

    调试

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

    调试

    授权信息

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

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

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dataworks:CreateAgentSession

    create

    *全部资源

    *

    		 无 无

    请求语法

    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 名称，必填

    • dataworks_data_agent ： DataWorks 系统内置智能体 (Agent) — Data Agent，覆盖数据集成、开发、运维、治理与分析全链路的智能化数据开发 AI 能力

    • dataworks_chatbi_agent ： DataWorks 系统内置智能体 (Agent) — ChatBI，基于自然语言处理与智能分析技术，通过对话交互实现从需求解析、数据抽取、代码自动生成到可视化报告输出的全流程自动化分析

    dataworks_data_agent
    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
    InitialConfigOptions

    object

    否

    Agent 执行环境的高级参数设置

    ExecutionLane

    string

    否

    执行模式：

    • chat：仅对话模式，适合简单的问数、答疑的场景，优点是快、token 消耗低，缺点是无法处理复杂问题

    • cli：沙箱模式，适合复杂的数据分析、数据处理、代码编写等场景，优点是能够处理复杂问题，模型自主进行分析和问题处理等，缺点是相对于 chat 模式处理速度慢，token 消耗较高

    chat，cli
    Mode

    string

    否

    脚本执行的授权模式（OpenApi 目前仅支持 yolo 模式）：

    • yolo：自动授权，无需人为介入，模型可以自动处理

    yolo
    Skills

    string

    否

    加载的自定义 skill 名称，多个用英文逗号相隔

    skill-name-1,skill-name2,skill-name-3
    ResourceGroupId

    string

    否

    初始化使用的资源组 id

    Serverless_res_group_123123123_564657857

    返回参数

    名称

    类型

    描述

    示例值

    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"
    }
  }
}

    错误码

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

    变更历史

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