Skip to content

docs(ai-sre): drop deprecated session/cancel from the public API #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysyneu merged 1 commit into from
Jun 24, 2026
Merged

docs(ai-sre): drop deprecated session/cancel from the public API #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 1 addition & 132 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22733,87 +22733,6 @@
}
}
}
},
"/safari/session/cancel": {
"post": {
"operationId": "session-write-cancel",
"summary": "Cancel run (deprecated)",
"description": "Deprecated backward-compatibility alias that stops an in-flight run.",
"tags": [
"AI SRE/Sessions"
],
"security": [
{
"AppKeyAuth": []
}
],
"x-mint": {
"content": "<Warning>\nThis operation is **deprecated** and retained only for backward compatibility. Avoid it in new integrations.\n</Warning>\n\n## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Provide `session_id` plus one of `invocation_id` / `root_invocation_id`.\n- Retained only for older embedded clients; new integrations should not depend on it.\n",
"href": "/en/api-reference/ai-sre/sessions/session-write-cancel",
"metadata": {
"sidebarTitle": "Cancel run (deprecated)"
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SessionInterruptAck"
}
}
}
]
},
"example": {
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"interrupted": true,
"session_id": "sess_f8oDvqiG64uur6sBNsTc4u",
"invocation_id": "inv_3kP9wQ2nLceRtY7uVb3xA1"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"500": {
"$ref": "#/components/responses/ServerError"
}
},
"deprecated": true,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionCancelRequest"
},
"example": {
"session_id": "sess_f8oDvqiG64uur6sBNsTc4u",
"invocation_id": "inv_3kP9wQ2nLceRtY7uVb3xA1"
}
}
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -41675,57 +41594,7 @@
"required": [
"session_id"
]
},
"SessionCancelRequest": {
"type": "object",
"description": "Stop an in-flight run. Provide session_id plus one of invocation_id or root_invocation_id.",
"properties": {
"session_id": {
"type": "string",
"description": "Target session ID.",
"minLength": 1
},
"invocation_id": {
"type": "string",
"description": "Invocation to interrupt. One of invocation_id / root_invocation_id is required.",
"minLength": 1
},
"root_invocation_id": {
"type": "string",
"description": "Root invocation to interrupt (collapses the whole turn including subagents).",
"minLength": 1
}
},
"required": [
"session_id"
]
},
"SessionInterruptAck": {
"type": "object",
"description": "Acknowledgement of an interrupt request.",
"properties": {
"interrupted": {
"type": "boolean",
"description": "True when a live invocation was found and signalled."
},
"session_id": {
"type": "string",
"description": "The session that was targeted."
},
"invocation_id": {
"type": "string",
"description": "Echo of the targeted invocation, when supplied."
},
"root_invocation_id": {
"type": "string",
"description": "Echo of the targeted root invocation, when supplied."
}
},
"required": [
"interrupted",
"session_id"
]
}
}
}
}
}
133 changes: 1 addition & 132 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22725,87 +22725,6 @@
}
}
}
},
"/safari/session/cancel": {
"post": {
"operationId": "session-write-cancel",
"summary": "取消运行（已废弃）",
"description": "已废弃的向后兼容别名，用于停止进行中的运行。",
"tags": [
"AI SRE/会话"
],
"security": [
{
"AppKeyAuth": []
}
],
"x-mint": {
"content": "<Warning>\n该接口已**废弃**，仅为向后兼容保留，新接入请勿使用。\n</Warning>\n\n## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个 `app_key` **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 需提供 `session_id`，以及 `invocation_id` / `root_invocation_id` 之一。\n- 仅为兼容旧版嵌入式客户端保留；新接入不应依赖该接口。\n",
"href": "/zh/api-reference/ai-sre/sessions/session-write-cancel",
"metadata": {
"sidebarTitle": "取消运行（已废弃）"
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ResponseEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SessionInterruptAck"
}
}
}
]
},
"example": {
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"interrupted": true,
"session_id": "sess_f8oDvqiG64uur6sBNsTc4u",
"invocation_id": "inv_3kP9wQ2nLceRtY7uVb3xA1"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"500": {
"$ref": "#/components/responses/ServerError"
}
},
"deprecated": true,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionCancelRequest"
},
"example": {
"session_id": "sess_f8oDvqiG64uur6sBNsTc4u",
"invocation_id": "inv_3kP9wQ2nLceRtY7uVb3xA1"
}
}
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -41666,57 +41585,7 @@
"required": [
"session_id"
]
},
"SessionCancelRequest": {
"type": "object",
"description": "停止一个进行中的运行。需提供 session_id，以及 invocation_id 或 root_invocation_id 之一。",
"properties": {
"session_id": {
"type": "string",
"description": "目标会话 ID。",
"minLength": 1
},
"invocation_id": {
"type": "string",
"description": "要中断的调用。invocation_id / root_invocation_id 二者必填其一。",
"minLength": 1
},
"root_invocation_id": {
"type": "string",
"description": "要中断的根调用（会一并收起整轮，含子智能体）。",
"minLength": 1
}
},
"required": [
"session_id"
]
},
"SessionInterruptAck": {
"type": "object",
"description": "中断请求的确认。",
"properties": {
"interrupted": {
"type": "boolean",
"description": "当找到并已向进行中的调用发出信号时为 true。"
},
"session_id": {
"type": "string",
"description": "被中断的会话。"
},
"invocation_id": {
"type": "string",
"description": "回显被中断的调用（如提供）。"
},
"root_invocation_id": {
"type": "string",
"description": "回显被中断的根调用（如提供）。"
}
},
"required": [
"interrupted",
"session_id"
]
}
}
}
}
}
Loading