Arkme 开放平台接入导航
Arkme 开放平台支持 REST API、MCP 和 DeepSeek Harness。选择一种接入方式后,使用同一把 API Key 即可开始调用。
开始接入
- 登录 开发者控制台。
- 创建 API Key,并立即保存只显示一次的完整 Key。
- 根据调用方选择接入方式。
| 调用方 | 接入方式 | 接入文档 |
|---|---|---|
| 服务端、脚本或桌面程序 | REST API | REST API 接入指南 |
| 用户直接把文档交给 Agent | MCP | MCP Agent 使用指南 |
| MCP Host、SDK 或插件开发者 | MCP | MCP 完整接入参考 |
| DeepSeek Harness | DSH MCP Client | DSH 接入指南 |
API Key 的创建、保存和删除方式参见 API Key 使用指南。
接收个人消息事件
没有公网回调地址时,接入方可以使用个人 API Key 主动绑定。REST 服务和 MCP Agent 使用同一协议,接入方选择如何唤起自己的处理程序。
| 步骤 | REST POST(前缀 /api/v1/message-subscriptions) |
MCP 工具 |
|---|---|---|
| 建立或恢复绑定 | /open,请求 {} |
open_message_subscription |
| 获取下一条 | /read,传 subscription_id 与可选 wait_seconds |
read_message_subscription |
| 确认进度 | /ack,传同一绑定和返回的 receipt |
ack_message_subscription |
| 解除绑定 | /close,传 subscription_id |
close_message_subscription |
每个操作使用同一把手工个人 Key。重复 open 返回原绑定;另一把 Key 即使属于同一账号,也有独立的队列和进度。订阅从启用时起接收新事件。将 wait_seconds 设为 1 至 5 可短暂等待;无可用等待配额时提前返回 idle,客户端应退避再读。使用一条连续的读取循环即可。
event带 event_id、type、id 和 reasons。先以 event_id 去重,按 type 查询当前可读消息并持久处理,再提交 receipt。相同回执可重复确认。断线后重复 open/read,从服务端已确认的位置继续。idle表示此刻没有未确认项。skipped表示对应位置已过期或权限已撤销,仅返回回执。closed表示当前 Key 上这个绑定已结束。gap表示未确认的积压超过每个 Key 的 64 条保留窗口。missed 为窗口外的位置数。先通过原会话查询核对当前状态,再确认 gap 的 receipt,从最早保留项继续。超过 24 小时的事件亦停止展示。正常消费与补查均不推进 App 的已读状态。
例如获取事件后,chat_message 的 id 可原样交给 read_chat_message_content;team_message 的 id 可原样交给 get_team_message。需要由平台主动发送到 HTTPS 服务时,在控制台为 Key 配置 消息 Webhook。两种方式可以独立使用,同时启用时同一事件具有相同 event_id。
持续处理工作消息
消息来源发现、会话增量读取、全文分片、附件清单和附件交付均可通过 REST 或 MCP 调用。按会话保存消费位置可用于主动对账。
处理顺序、撤权与变更恢复、正文及附件完整性规则见 MCP Agent 使用指南。本地或服务端运行器负责把完整、可追溯的工作材料转换成工作安排,并保留尚未完成的转写、附件或外部材料。