HTTP API

HTTP API

CipherTalk 内嵌了一个本地 HTTP 服务，供外部程序调用聊天数据。

基本信息

• Base URL：http://127.0.0.1:5031
• API 前缀：/v1
• 协议：HTTP/1.1
• 响应格式：application/json; charset=utf-8
• 访问范围：仅本机（不暴露到局域网）

启用方式

1. 打开软件，进入 设置 → AI
2. 找到「开放接口」开关，启用
3. 可选：配置访问密钥（Token）和端口号（默认 5031）

鉴权

配置了访问密钥后，所有请求需携带：

Authorization: Bearer <token>

未配置密钥时可匿名访问。

统一响应格式

成功响应

{
  "success": true,
  "data": {},
  "meta": {
    "ts": 1740988800000,
    "requestId": "req_1740988800000_ab12cd34"
  }
}

失败响应

{
  "success": false,
  "error": {
    "code": "INVALID_PARAM",
    "message": "sessionId is required"
  },
  "meta": {
    "ts": 1740988800000,
    "requestId": "req_1740988800000_ab12cd34"
  }
}

接口列表

方法	路径	说明
GET	/v1/health	健康检查
GET	/v1/status	服务状态信息
GET	/v1/sessions	获取会话列表
GET	/v1/contacts	获取联系人列表
GET	/v1/messages	获取消息列表

详细文档

• HTTP API - 会话接口
• HTTP API - 联系人接口
• HTTP API - 消息接口

版本策略

• 非破坏性更新在 /v1 内新增字段或接口
• 破坏性更新发布 /v2，并保留 /v1 一段兼容期