Introdução geral
Cursor API é um projeto de código aberto que visa converter os recursos de IA do editor Cursor em um serviço de interface compatível com a API OpenAI. Por meio desse projeto, os usuários podem reutilizar os recursos de IA do Cursor em outros aplicativos, possibilitando assim uma variedade maior de cenários de aplicativos. O projeto oferece uma variedade de métodos de implementação, incluindo Docker, Docker Compose e PM2, etc., o que é conveniente para os usuários escolherem e usarem de acordo com suas próprias necessidades. A API do Cursor não só oferece suporte às interfaces básicas de diálogo, mas também fornece descrições detalhadas da interface e guias de uso para ajudar os usuários a começar rapidamente. Suplementarcursor-api.
Apenas para fins de aprendizado, o Cursor2API tem mais problemas do que pode ser estabilizado.
Lista de funções
- Conversão dos recursos de IA do editor Cursor em uma interface compatível com OpenAI
- Oferece suporte a vários métodos de implantação: Docker, Docker Compose, PM2
- Fornecer descrições detalhadas da interface e diretrizes de uso
- Suporte para a interface de diálogo básica
- Compatível com uma ampla gama de modelos de IA
Usando a Ajuda
Processo de instalação
- Implantação do Docker Compose (recomendado)
- Execute o seguinte comando no terminal:
bash
docker compose up -d
- Execute o seguinte comando no terminal:
- Implementação do Docker
- Execute o seguinte comando no terminal:
bash
docker run -d --name cursor-api -p 3000:3000 waitkafuka/cursor-api:latest
- Execute o seguinte comando no terminal:
- Implantação do PM2
- Execute o seguinte comando no terminal:
bash
cd cursor-api
npm install
pm2 start ecosystem.config.js
- Execute o seguinte comando no terminal:
Diretrizes para uso
- Obter WorkosCursorSessionToken
- Visite o site do Cursor e conclua o login de registro.
- Abra o Developer Tools em seu navegador (F12), localize o valor chamado WorkosCursorSessionToken em Application-Cookies e salve-o.
- Configurar a interface
- Endereço da interface:
http://localhost:3000/v1/chat/completions
- Método de solicitação: POST
- Método de autenticação: Token do portador (usando o valor de WorkosCursorSessionToken)
- Endereço da interface:
- Formato da solicitação
{
"model": "gpt-3.5-turbo", "model": [
"messages": [
{
"role": "user", "content": "Olá, como posso usar a API do Cursor?
"content": "Olá, como posso usar a API do Cursor?"
}
]
}
- formato de resposta
{
"id": "chatcmpl-123",
"choices": [
{
"index" (índice): 0, "message" (mensagem): {
"message" (mensagem): {
"função": "assistente", "conteúdo": "Você pode usar a API do Cursor seguindo as diretrizes de instalação e uso fornecidas na documentação.
"content": "Você pode usar a API do Cursor seguindo as diretrizes de instalação e uso fornecidas na documentação."
}, "finish_reason".
"finish_reason": "stop"
}
}, "finish_reason": "stop" }
"usage": {
"completion_tokens": 12, "total_tokens": 21, "completion_tokens": 20
"total_tokens": 21
}
}
advertência
- Mantenha seu WorkosCursorSessionToken em segurança e não o divulgue para outras pessoas.
- Este projeto é apenas para uso em estudos e pesquisas. Siga os termos de uso do Cursor.
Tutorial de atualização do checksum da API do cursor
Este documento o orientará sobre como atualizar o valor da soma de verificação da API do Cursor.
Etapas de atualização
1. descomissionamento de embalagens existentes
docker stop cursor-api
2. exclusão de embalagens antigas
docker rm cursor-api
3. obtenha o novo valor de soma de verificação
Nova soma de verificação (a expirar em breve)
4. reinicie o contêiner com o novo valor de soma de verificação
docker run -d --name cursor-api -e x-cursor-checksum=substituir pelo valor de checksum solicitado -p 3000:3000 zhx47/cursor-api:latest
Validação da implantação
Quando a atualização for concluída, você poderá verificar o status do contêiner usando o seguinte comando:
docker ps | grep cursor-api
Comando Exibir valor de soma de verificação atualizado:
docker exec cursor-api env | grep x-cursor-checksum