Como usar a chave de API do GitHub Copilot com a API Cursor

Compreendendo a Compatibilidade da Chave de API

Quando os desenvolvedores se referem a uma chave de API do github copilot, eles geralmente estão se referindo a um token gerado dentro do ecossistema Microsoft GitHub. Essa chave autentica requisições aos servidores da Microsoft, que executam modelos como GPT-4o ou variantes especializadas otimizadas para código. Embora esses modelos sejam poderosos, eles vêm com filtros de conteúdo específicos e limites de requisições vinculados à sua conta Microsoft.

Em contraste, a API Cursor opera como um serviço independente. Ela não depende da infraestrutura da Microsoft. Em vez disso, ela serve um único modelo de linguagem grande de pesos abertos otimizado para contextos de codificação. Este modelo foi projetado para responder sem recusas de conteúdo para uso adulto lícito, tornando-se uma alternativa distinta para desenvolvedores que acham os filtros padrão restritivos.

Compreender essa distinção é crucial. Sua chave de API do GitHub Copilot existente não funcionará com o endpoint da API Cursor. Você precisa de uma chave separada gerada na sua conta em cursorapikey.com. No entanto, o protocolo subjacente permanece o mesmo, o que significa que seu código não precisa ser alterado significativamente.

Configurando Seu Ambiente

Para usar a API Cursor, você primeiro precisa gerar uma chave. Cadastre-se na página Obter chave de API com apenas um e-mail e senha. Nenhum cartão de crédito é necessário para o crédito de teste inicial. Uma vez registrado, sua chave é exibida imediatamente. Armazene esta chave com segurança nas variáveis de ambiente, tipicamente como OPENAI_API_KEY ou uma variável personalizada dependendo dos requisitos do seu agente.

A maioria dos agentes de codificação, incluindo Cursor e ferramentas semelhantes, depende do padrão SDK OpenAI. Isso significa que você não precisa de uma biblioteca personalizada. Você simplesmente precisa apontar seu SDK para a URL base correta. A URL base para a API Cursor é https://api.cursorapikey.com/v1. Este endpoint é totalmente compatível com OpenAI, suportando as mesmas estruturas de requisição com as quais você já está familiarizado.

Certifique-se de que seu ambiente esteja configurado para enviar requisições para esta nova URL base. O ID do modelo que você deve especificar em suas requisições é uncensored. Isso diz à API qual modelo específico invocar. É um modelo de pesos abertos executado em nossos próprios servidores GPU, distinto de GPT, Claude ou Gemini.

Alterando URLs Base

Alternar de uma chave de API do github copilot para a API Cursor envolve principalmente alterar a URL base na configuração do seu cliente. Se você estiver usando os SDKs oficiais Python ou Node.js da OpenAI, isso é uma alteração de uma linha. Por exemplo, em Python, você inicializaria o cliente com a nova URL base e sua nova chave de API.

Essa alteração redireciona suas requisições dos servidores da Microsoft para nossa infraestrutura. Os benefícios incluem acesso a uma janela de contexto de 100.000 tokens e um modelo ajustado para menos recusas. Você pode verificar a conexão verificando o endpoint /v1/models, que deve retornar os modelos disponíveis, incluindo uncensored.

Compromisso: Embora a sintaxe seja idêntica, você está pagando por token em vez de por meio de uma assinatura da Microsoft. Nosso preço é transparente: $0,25 por 1M de tokens de entrada e $1,00 por 1M de tokens de saída. Não há mensalidades, apenas crédito pagamento por uso que nunca expira. Este modelo é ideal para cargas de trabalho variáveis, onde você não quer se comprometer com o custo de uma licença mensal.

Testando Sua Conexão

Antes de integrar a API no seu fluxo de trabalho principal, é essencial verificar se seu ambiente pode se comunicar com a API Cursor. Você pode fazer isso com um comando cURL simples ou um script curto. Este teste garante que sua chave é válida e que a URL base está correta.

Exemplo de solicitação cURL:

Envie uma requisição POST para https://api.cursorapikey.com/v1/chat/completions com o modelo definido como uncensored. Inclua um prompt simples no array messages. Uma resposta bem-sucedida retornará uma conclusão no campo choices[0].message.content.

Se você receber um erro 401, sua chave de API está incorreta. Se receber um erro 429, você excedeu o limite de requisições de 300 solicitações por minuto por chave. Você pode regenerar sua chave a qualquer momento para invalidar a anterior. Este teste confirma que a funcionalidade básica de entrada de texto e saída de texto está funcionando conforme o esperado.

Gerenciando Respostas de Streaming

Para agentes de codificação, respostas de streaming são críticas para fornecer uma experiência de usuário suave. A API Cursor oferece suporte a Server-Sent Events (SSE) para streaming. Isso permite que você receba tokens conforme são gerados, em vez de esperar pela resposta completa.

Ao usar o SDK do OpenAI, você pode ativar o streaming definindo o parâmetro stream como true. O SDK fornecerá blocos de dados conforme eles chegam. Isso é particularmente útil para longas gerações de código, onde você deseja exibir o progresso ao usuário ou alimentar tokens em um editor ao vivo.

Esteja ciente de que o streaming não altera o modelo subjacente ou suas capacidades. É puramente um mecanismo de entrega. O modelo uncensored ainda aderirá à janela de contexto de 100.000 tokens e à mesma estrutura de preços. O streaming é um recurso do lado do cliente que melhora a latência percebida sem afetar o comportamento do modelo.

Integração de Chamada de Funções

Assistentes de codificação de IA modernos dependem fortemente de chamada de funções (function calling) para interagir com o mundo externo, como executar comandos de shell ou acessar arquivos. A API Cursor oferece suporte a isso através do formato padrão compatível com OpenAI.

Você pode definir ferramentas em sua requisição usando o parâmetro tools. O modelo responderá com um array tool_calls se determinar que uma ferramenta deve ser usada. Seu aplicativo deve então executar a ferramenta e enviar os resultados de volta para a API em uma mensagem subsequente.

Este processo é idêntico a como você usaria uma chave de API do github copilot com os modelos da Microsoft. A vantagem aqui é a consistência. Se você tem código existente para chamada de funções, provavelmente pode reutilizá-lo com ajustes mínimos. Apenas certifique-se de que suas definições de ferramentas correspondam ao esquema esperado para o modelo uncensored.

Monitorando o Uso

Como você está pagando por token, monitorar seu uso é importante para evitar custos inesperados. A API Cursor fornece um painel onde você pode visualizar o saldo do seu crédito e o histórico de uso. Você pode ver quantos tokens consumiu e quanto crédito resta.

Limites principais a observar:

• Limite de taxa: 300 requisições por minuto por chave.
• Tamanho do corpo da requisição: Máximo 8 MB por requisição.
• Janela de contexto: 100.000 tokens no total (entrada + saída).

Se você exceder o limite de taxa, receberá um erro 429. Você pode monitorar seu uso em tempo real para garantir que permaneça dentro desses limites. Além disso, você pode regenerar sua chave de API se suspeitar que foi comprometida, o que invalida imediatamente a chave antiga.

Solucionando Problemas Comuns

Mesmo com uma API robusta, problemas podem surgir. Aqui estão alguns problemas comuns e suas soluções.

401 Não Autorizado: Verifique sua chave de API. Certifique-se de que foi copiada corretamente e não possui espaços à esquerda ou à direita. Se você regenerou sua chave, certifique-se de estar usando a nova.

429 Muitos Requests: Você excedeu o limite de 300 requisições por minuto. Implemente backoff exponencial no seu cliente ou reduza a frequência de suas requisições.

400 Bad Request: Isso geralmente indica um payload JSON malformado ou campos obrigatórios ausentes. Certifique-se de que sua matriz messages esteja formatada corretamente e inclua os campos role e content. Além disso, verifique se o nome do modelo é exatamente uncensored.

Bloqueio de Conteúdo: Embora o modelo seja sem censura, ele bloqueia conteúdo sexual envolvendo menores. Se sua requisição for bloqueada, pode ser devido a esse limite rígido específico.