综合介绍
Cursor API是一个开源项目,旨在将Cursor编辑器的AI能力转换为与OpenAI API兼容的接口服务。通过该项目,用户可以在其他应用中复用Cursor的AI能力,从而实现更广泛的应用场景。该项目提供了多种部署方式,包括Docker、Docker Compose和PM2等,方便用户根据自身需求进行选择和使用。Cursor API不仅支持基础的对话接口,还提供了详细的接口说明和使用指南,帮助用户快速上手。补充cursor-api。
仅用于学习,Cursor2API问题较多,无法稳定使用。
功能列表
- 将Cursor编辑器的AI能力转换为OpenAI兼容接口
- 支持多种部署方式:Docker、Docker Compose、PM2
- 提供详细的接口说明和使用指南
- 支持基础对话接口
- 兼容多种AI模型
使用帮助
安装流程
- Docker Compose部署(推荐)
- 在终端中运行以下命令:
bash
docker compose up -d
- 在终端中运行以下命令:
- Docker部署
- 在终端中运行以下命令:
bash
docker run -d --name cursor-api -p 3000:3000 waitkafuka/cursor-api:latest
- 在终端中运行以下命令:
- PM2部署
- 在终端中运行以下命令:
bash
cd cursor-api
npm install
pm2 start ecosystem.config.js
- 在终端中运行以下命令:
使用指南
- 获取WorkosCursorSessionToken
- 访问Cursor官网并完成注册登录。
- 在浏览器中打开开发者工具(F12),找到应用-Cookies中名为WorkosCursorSessionToken的值并保存。
- 配置接口
- 接口地址:
http://localhost:3000/v1/chat/completions
- 请求方法:POST
- 认证方式:Bearer Token(使用WorkosCursorSessionToken的值)
- 接口地址:
- 请求格式
{
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "user",
"content": "Hello, how can I use Cursor API?"
}
]
}
- 响应格式
{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652280,
"model": "gpt-3.5-turbo",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "You can use Cursor API by following the installation and usage guidelines provided in the documentation."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 9,
"completion_tokens": 12,
"total_tokens": 21
}
}
注意事项
- 请妥善保管您的WorkosCursorSessionToken,不要泄露给他人。
- 本项目仅供学习研究使用,请遵守Cursor的使用条款。
Cursor-API Checksum 更新教程
本文档将指导您如何更新 Cursor-API 的 checksum 值。
更新步骤
1. 停止现有容器
docker stop cursor-api
2. 删除旧容器
docker rm cursor-api
3.获取新的 checksum 值
4. 使用新的 checksum 值重启容器
docker run -d --name cursor-api -e x-cursor-checksum=替换为请求的checksum值 -p 3000:3000 zhx47/cursor-api:latest
验证部署
更新完成后,可以使用以下命令验证容器状态:
docker ps | grep cursor-api
查看更新后的 checksum 值命令:
docker exec cursor-api env | grep x-cursor-checksum