创建会话

该 API 用于创建与某个飞书 Aily 应用的一次会话（Session）；当创建会话成功后，可以发送消息、创建运行。

Tip: 更多信息及示例代码，可参考 Aily OpenAPI 接入与接口说明。

实体概念说明

• 会话（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。
• 消息（Message）：消息可以包含文本、表格、图片等多种类型的内容。
• 运行（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/aily/v1/sessions
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	aily:session:write 读写会话信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"
X-Aily-BizUserID	string	否	唯一用户身份标识。 > 建议使用唯一内部 ID 或其他可标识用户唯一身份的字段（如飞书账号的 user_id），可用于分析来自 API 的具体用户 示例值："ou_5ad573a6411d72b8305fda3a9c15c70e" 数据校验规则： - 长度范围：0 ～ 255 字符

请求体

名称	类型	必填	描述
channel_context	string	否	可自行构造的 Context 上下文变量；在 Workflow 技能中可消费这部分全局变量 示例值："{}" 数据校验规则： - 长度范围：0 ～ 255 字符
metadata	string	否	会话的自定义变量内容，变量数据保存在服务端 Session 中，可在 GetSession 时原样返回，无需在 API 调用侧存储 示例值："{}" 数据校验规则： - 长度范围：0 ～ 255 字符

请求体示例

{
    "channel_context": "{}",
    "metadata": "{}"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ session	aily_session	创建的会话信息
└ id	string	会话 ID
└ created_at	string	会话的创建时间，毫秒时间戳
└ modified_at	string	会话的上次更新时间，毫秒时间戳
└ created_by	string	会话的创建人（Aily UserID）
└ channel_context	string	可自行构造的 Context 上下文变量；在 Workflow 技能中可消费这部分全局变量
└ metadata	string	会话的自定义变量内容，变量数据保存在服务端 Session 中，可在 GetSession 时原样返回，无需在 API 调用侧存储

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "session": {
            "id": "session_4dfunz7sp1g8m",
            "created_at": "1711975665710",
            "modified_at": "1711975665710",
            "created_by": "1794840334557292",
            "channel_context": "{}",
            "metadata": "{}"
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	2700001	param is invalid	参数错误