cursor-api

说明

当前版本已稳定，若发现响应出现缺字漏字，与本程序无关。
若发现首字慢，与本程序无关。
若发现响应出现乱码，也与本程序无关。
属于官方的问题，请不要像作者反馈。
本程序拥有堪比客户端原本的速度，甚至可能更快。
本程序的性能是非常厉害的。

获取key

访问 www.cursor.com 并完成注册登录
在浏览器中打开开发者工具（F12）
在 Application-Cookies 中查找名为 WorkosCursorSessionToken 的条目，并复制其第三个字段。请注意，%3A%3A 是 :: 的 URL 编码形式，cookie 的值使用冒号 (:) 进行分隔。

配置说明

环境变量

PORT: 服务器端口号（默认：3000）
AUTH_TOKEN: 认证令牌（必须，用于API认证）
ROUTE_PREFIX: 路由前缀（可选）
TOKEN_FILE: token文件路径（默认：.token）
TOKEN_LIST_FILE: token列表文件路径（默认：.token-list）

更多请查看 /env-example

Token文件格式

.token 文件：每行一个token，支持以下格式：
```
# 这是注释
token1
# alias与标签的作用差不多
alias::token2
```
alias 可以是任意值，用于区分不同的 token，更方便管理，WorkosCursorSessionToken 是相同格式
该文件将自动向.token-list文件中追加token，同时自动生成checksum
.token-list 文件：每行为token和checksum的对应关系：
```
# 这里的#表示这行在下次读取要删除
token1,checksum1
# 支持像.token一样的alias，冲突时以.token为准
alias::token2,checksum2
```
该文件可以被自动管理，但用户仅可在确认自己拥有修改能力时修改，一般仅有以下情况需要手动修改：
- 需要删除某个 token
- 需要使用已有 checksum 来对应某一个 token

模型列表

写死了，后续也不会会支持自定义模型列表

claude-3.5-sonnet
gpt-4
gpt-4o
claude-3-opus
cursor-fast
cursor-small
gpt-3.5-turbo
gpt-4-turbo-2024-04-09
gpt-4o-128k
gemini-1.5-flash-500k
claude-3-haiku-200k
claude-3-5-sonnet-200k
claude-3-5-sonnet-20241022
gpt-4o-mini
o1-mini
o1-preview
o1
claude-3.5-haiku
gemini-exp-1206
gemini-2.0-flash-thinking-exp
gemini-2.0-flash-exp

接口说明

基础对话

接口地址: /v1/chat/completions
请求方法: POST
认证方式: Bearer Token
1. 使用环境变量 AUTH_TOKEN 进行认证
2. 使用 .token 文件中的令牌列表进行轮询认证

请求格式

{
  "model": "string",
  "messages": [
    {
      "role": "system" | "user" | "assistant", // 也可以是 "developer" | "human" | "ai"
      "content": "string" | [
        {
          "type": "text" | "image_url",
          "text": "string",
          "image_url": {
            "url": "string"
          }
        }
      ]
    }
  ],
  "stream": boolean
}

响应格式

如果 stream 为 false:

{
  "id": "string",
  "object": "chat.completion",
  "created": number,
  "model": "string",
  "choices": [
    {
      "index": number,
      "message": {
        "role": "assistant",
        "content": "string"
      },
      "finish_reason": "stop" | "length"
    }
  ],
  "usage": {
    "prompt_tokens": number,
    "completion_tokens": number,
    "total_tokens": number
  }
}

如果 stream 为 true:

data: {"id":"string","object":"chat.completion.chunk","created":number,"model":"string","choices":[{"index":number,"delta":{"role":"assistant","content":"string"},"finish_reason":null}]}

data: {"id":"string","object":"chat.completion.chunk","created":number,"model":"string","choices":[{"index":number,"delta":{"content":"string"},"finish_reason":null}]}

data: {"id":"string","object":"chat.completion.chunk","created":number,"model":"string","choices":[{"index":number,"delta":{},"finish_reason":"stop"}]}

data: [DONE]

Token管理接口

简易Token信息管理页面

接口地址: /tokeninfo
请求方法: GET
响应格式: HTML页面
功能: 获取 .token 和 .token-list 文件内容,并允许用户方便地使用 API 修改文件内容

更新Token信息 (GET)

接口地址: /update-tokeninfo
请求方法: GET
认证方式: 不需要
功能: 请求内容不包括文件内容,直接修改文件,调用重载函数

更新Token信息 (POST)

接口地址: /update-tokeninfo
请求方法: POST
认证方式: Bearer Token
请求格式:

{
  "tokens": "string",
  "token_list": "string"
}

响应格式:

{
  "status": "success",
  "message": "Token files have been updated and reloaded",
  "token_file": "string",
  "token_list_file": "string",
  "token_count": number
}

获取Token信息

接口地址: /get-tokeninfo
请求方法: POST
认证方式: Bearer Token
响应格式:

{
  "status": "success",
  "token_file": "string",
  "token_list_file": "string",
  "tokens": "string",
  "token_list": "string"
}

配置管理接口

配置页面

接口地址: /config
请求方法: GET
响应格式: HTML页面
功能: 提供配置管理界面,可以修改页面内容和系统配置

更新配置

接口地址: /config
请求方法: POST
认证方式: Bearer Token
请求格式:

{
  "action": "get" | "update" | "reset",
  "path": "string",
  "content": "string",
  "content_type": "default" | "text" | "html",
  "enable_stream_check": boolean,
  "enable_stream_check": boolean,
  "vision_ability": "none" | "base64" | "all", // "disabled" | "base64-only" | "base64-http"
  "enable_slow_pool": boolean,
  "enable_slow_pool": boolean
}

响应格式:

{
  "status": "success",
  "message": "string",
  "data": {
    "page_content": {
      "type": "default" | "text" | "html",
      "content": "string"
    },
    "enable_stream_check": boolean,
    "vision_ability": "base64" | "url" | "none", 
    "enable_slow_pool": boolean
  }
}

静态资源接口

获取共享样式

接口地址: /static/shared-styles.css
请求方法: GET
响应格式: CSS文件
功能: 获取共享样式表

获取共享脚本

接口地址: /static/shared.js
请求方法: GET
响应格式: JavaScript文件
功能: 获取共享JavaScript代码

环境变量示例

接口地址: /env-example
请求方法: GET
响应格式: 文本文件
功能: 获取环境变量配置示例

其他接口

获取模型列表

接口地址: /v1/models
请求方法: GET
响应格式:

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "model",
      "created": number,
      "owned_by": "string"
    }
  ]
}

获取随机checksum

接口地址: /checksum
请求方法: GET
响应格式:

{
  "checksum": "string"
}

健康检查接口

接口地址: /health 或 /(重定向)
请求方法: GET
响应格式: 根据配置返回不同的内容类型(默认、文本或HTML)

获取日志接口

接口地址: /logs
请求方法: GET
响应格式: 根据配置返回不同的内容类型(默认、文本或HTML)

获取日志数据

接口地址: /logs
请求方法: POST
认证方式: Bearer Token
响应格式:

{
  "total": number,
  "logs": [
    {
      "timestamp": "string",
      "model": "string",
      "token_info": {
        "token": "string",
        "checksum": "string",
        "alias": "string"
      },
      "prompt": "string",
      "stream": boolean,
      "status": "string",
      "error": "string"
    }
  ],
  "timestamp": "string",
  "status": "success"
}