devin15/r4-rust

1# Cursor API2 3## 项目说明4 5### 版本声明6- 当前版本已进入稳定阶段7- 以下问题与程序无关，请勿反馈：8  - 响应缺字漏字9  - 首字延迟现象10  - 响应出现乱码11- 性能优势：12  - 达到原生客户端响应速度13  - 部分场景下表现更优14- 开源协议要求：15  - Fork 项目禁止以原作者名义进行宣传推广16  - 禁止发布任何形式的官方声明17 18![Cursor API 架构示意图](https://via.placeholder.com/800x400.png?text=Cursor+API+Architecture)19 20## 快速入门21 22### 密钥获取231. 访问 [Cursor 官网](https://www.cursor.com) 完成注册登录242. 开启浏览器开发者工具 (F12)253. 在 Application → Cookies 中定位 `WorkosCursorSessionToken`264. 复制第三个字段值（注意：`%3A%3A` 为 `::` 的 URL 编码形式）27 28## 配置指南29 30### 环境变量31| 变量名 | 类型 | 默认值 | 说明 |32|--------|------|--------|-----|33| PORT   | int  | 3000   | 服务端口号 |34| AUTH_TOKEN | string | 无 | 认证令牌（必需） |35| ROUTE_PREFIX | string | 无 | 路由前缀 |36| TOKEN_LIST_FILE | string | .tokens | Token 存储文件 |37 38完整配置参见 [env-example](/env-example)39 40### Token 文件规范41`.tokens` 文件格式：42```plaintext43# 注释行将在下次读取时自动删除44token1,checksum145token2,checksum246```47 48文件管理原则：49- 系统自动维护文件内容50- 仅以下情况需要手动编辑：51  - 删除特定 token52  - 绑定已有 checksum 到指定 token53 54## 模型支持列表55```json56[57  "claude-3.5-sonnet",58  "gpt-4",59  "gpt-4o",60  "cursor-fast",61  "gpt-4o-mini",62  "deepseek-v3"63]64```65*注：模型列表为固定配置，暂不支持自定义扩展*66 67## API 文档68 69### 基础对话接口70**Endpoint**71`POST /v1/chat/completions`72 73**认证方式**74`Bearer Token` 三级认证机制：751. 环境变量 `AUTH_TOKEN`762. `.token` 文件轮询773. 直接 token,checksum 认证（v0.1.3-rc.3+）78 79**请求示例**80```json81{82  "model": "gpt-4",83  "messages": [84    {85      "role": "user",86      "content": "解释量子计算的基本原理"87    }88  ],89  "stream": false90}91```92 93**响应示例（非流式）**94```json95{96  "id": "chatcmpl-9Xy...",97  "object": "chat.completion",98  "created": 1628063500,99  "model": "gpt-4",100  "choices": [{101    "index": 0,102    "message": {103      "role": "assistant",104      "content": "量子计算基于量子比特..."105    },106    "finish_reason": "stop"107  }]108}109```110 111### Token 管理接口112| 端点 | 方法 | 功能 |113|------|------|-----|114| `/tokens` | GET | Token 信息管理界面 |115| `/tokens/update` | POST | 批量更新 Token 列表 |116| `/tokens/add` | POST | 增量添加 Token |117| `/tokens/delete` | POST | 删除指定 Token |118 119```mermaid120sequenceDiagram121    participant Client122    participant API123    Client->>API: POST /tokens/add124    API->>API: 验证Token有效性125    API->>File: 写入.tokens126    API-->>Client: 返回更新结果127```128 129## 高级功能130 131### 动态密钥生成132**Endpoint**133`POST /build-key`134 135**优势对比**136| 特性 | 传统模式 | 动态密钥 |137|------|---------|---------|138| 密钥长度 | 较长 | 优化缩短 |139| 配置扩展 | 无 | 支持自定义 |140| 安全等级 | 基础 | 增强编码 |141| 验证效率 | 预校验耗时 | 即时验证 |142 143## 系统监控144 145### 健康检查146**Endpoint**147`GET /health`148 149**响应示例**150```json151{152  "status": "success",153  "version": "1.2.0",154  "uptime": 86400,155  "models": ["gpt-4", "claude-3.5"],156  "endpoints": ["/v1/chat", "/tokens"]157}158```159 160## 生态工具161 162### 开发辅助工具163- [Token 获取工具](https://github.com/wisdgod/cursor-api/tree/main/tools/get-token)164  支持 Windows/Linux/macOS 系统165- [遥测数据重置工具](https://github.com/wisdgod/cursor-api/tree/main/tools/reset-telemetry)166  清除用户使用数据记录167 168## 致谢声明169本项目的发展离不开以下开源项目的启发：170- [zhx47/cursor-api](https://github.com/zhx47/cursor-api) - 基础架构参考171- [cursorToApi](https://github.com/luolazyandlazy/cursorToApi) - 认证机制优化方案172 173--- 174 175> **项目维护说明**176> 我们欢迎社区贡献，但请注意：177> 1. 功能请求需附带使用场景说明178> 2. Bug 报告请提供复现步骤和环境信息179> 3. 重要变更需通过 CI/CD 测试流程