Cách sử dụng khóa API GitHub Copilot với API Cursor

Hiểu về khả năng tương thích khóa API

Khi các nhà phát triển đề cập đến khóa API GitHub Copilot, họ thường đề cập đến một token được tạo trong hệ sinh thái Microsoft GitHub. Khóa này xác thực các yêu cầu đến máy chủ của Microsoft, nơi chạy các mô hình như GPT-4o hoặc các biến thể chuyên dụng được tối ưu hóa cho mã. Mặc dù các mô hình này mạnh mẽ, chúng có các bộ lọc nội dung và giới hạn tốc độ cụ thể liên kết với tài khoản Microsoft của bạn.

Ngược lại, API Cursor hoạt động như một dịch vụ độc lập. Nó không dựa vào hạ tầng của Microsoft. Thay vào đó, nó cung cấp một mô hình ngôn ngữ lớn trọng số mở duy nhất được tối ưu cho ngữ cảnh lập trình. Mô hình này được thiết kế để trả lời mà không từ chối nội dung cho mục đích người trưởng thành hợp pháp, tạo thành một lựa chọn khác biệt cho các lập trình viên thấy các bộ lọc tiêu chuẩn hạn chế.

Hiểu rõ sự khác biệt này là rất quan trọng. Khóa API GitHub Copilot hiện tại của bạn sẽ không hoạt động với endpoint API Cursor. Bạn cần một khóa riêng được tạo từ tài khoản của bạn trên cursorapikey.com. Tuy nhiên, giao thức cơ bản vẫn giống nhau, nghĩa là mã của bạn không cần thay đổi đáng kể.

Cấu hình môi trường của bạn

Để sử dụng API Cursor, trước tiên bạn cần tạo khóa. Đăng ký trên trang Lấy khóa API chỉ bằng email và mật khẩu. Không cần thẻ tín dụng cho tín dụng dùng thử ban đầu. Sau khi đăng ký, khóa của bạn sẽ được hiển thị ngay lập tức. Hãy lưu khóa này một cách an toàn trong các biến môi trường của bạn, thường là OPENAI_API_KEY hoặc một biến tùy chỉnh tùy thuộc vào yêu cầu của agent của bạn.

Hầu hết các agent lập trình, bao gồm Cursor và các công cụ tương tự, dựa trên tiêu chuẩn SDK OpenAI. Điều này có nghĩa là bạn không cần thư viện tùy chỉnh. Bạn chỉ cần trỏ SDK của mình đến base URL chính xác. Base URL cho API Cursor là https://api.cursorapikey.com/v1. Endpoint này tương thích hoàn toàn với OpenAI, hỗ trợ cùng cấu trúc yêu cầu mà bạn đã quen thuộc.

Đảm bảo môi trường của bạn được cấu hình để gửi yêu cầu đến base URL mới này. ID mô hình bạn phải chỉ định trong yêu cầu là uncensored. Điều này báo cho API biết mô hình cụ thể nào cần kích hoạt. Đây là một mô hình trọng số mở chạy trên máy chủ GPU của chúng tôi, khác biệt với GPT, Claude hoặc Gemini.

Chuyển đổi Base URL

Chuyển từ khóa API github copilot sang API Cursor chủ yếu liên quan đến việc thay đổi base URL trong cấu hình client của bạn. Nếu bạn dùng SDK Python hoặc Node.js chính thức của OpenAI, đây là một thay đổi dòng lệnh. Ví dụ, trong Python, bạn khởi tạo client với base URL mới và khóa API mới của bạn.

Thay đổi này chuyển hướng các yêu cầu của bạn từ máy chủ của Microsoft sang hạ tầng của chúng tôi. Lợi ích bao gồm truy cập vào cửa sổ ngữ cảnh 100.000 token và mô hình được tinh chỉnh để ít từ chối hơn. Bạn có thể xác minh kết nối bằng cách kiểm tra endpoint /v1/models, endpoint này sẽ trả về các mô hình có sẵn, bao gồm uncensored.

Sự đánh đổi: Mặc dù cú pháp giống hệt nhau, bạn hiện đang trả tiền theo token thay vì thông qua gói đăng ký Microsoft. Giá của chúng tôi minh bạch: $0.25 cho mỗi 1M token đầu vào và $1.00 cho mỗi 1M token đầu ra. Không có phí hàng tháng, chỉ có tín dụng trả theo nhu cầu không bao giờ hết hạn. Mô hình này lý tưởng cho các khối lượng công việc biến động khi bạn không muốn cam kết chi phí ghế hàng tháng.

Kiểm tra kết nối của bạn

Trước khi tích hợp API vào quy trình làm việc chính của bạn, điều cần thiết là xác minh rằng môi trường của bạn có thể giao tiếp với API Cursor. Bạn có thể làm điều này bằng một lệnh cURL đơn giản hoặc một đoạn script ngắn. Bài kiểm tra này đảm bảo khóa của bạn hợp lệ và URL cơ sở là chính xác.

Ví dụ yêu cầu cURL:

Gửi yêu cầu POST đến https://api.cursorapikey.com/v1/chat/completions với mô hình được đặt thành uncensored. Bao gồm một prompt đơn giản trong mảng messages. Phản hồi thành công sẽ trả về kết quả trong trường choices[0].message.content.

Nếu bạn nhận được lỗi 401, khóa API của bạn không chính xác. Nếu bạn nhận được lỗi 429, bạn đã vượt quá giới hạn tốc độ 300 yêu cầu mỗi phút mỗi khóa. Bạn có thể tạo lại khóa của mình bất cứ lúc nào để vô hiệu hóa khóa cũ. Bài kiểm tra này xác nhận rằng chức năng văn bản vào, văn bản ra cơ bản đang hoạt động như mong đợi.

Xử lý phản hồi truyền phát

Đối với các agent lập trình, phản hồi truyền phát rất quan trọng để cung cấp trải nghiệm người dùng mượt mà. API Cursor hỗ trợ Server-Sent Events (SSE) cho truyền phát. Điều này cho phép bạn nhận token khi chúng được tạo, thay vì chờ phản hồi đầy đủ.

Khi dùng SDK OpenAI, bạn có thể bật truyền phát bằng cách đặt tham số stream thành true. SDK sẽ trả về các chunk dữ liệu khi chúng đến. Điều này đặc biệt hữu ích cho các thế hệ mã dài, nơi bạn muốn hiển thị tiến trình cho người dùng hoặc đưa token vào trình soạn thảo trực tiếp.

Hãy lưu ý rằng truyền phát không thay đổi mô hình cơ bản hoặc khả năng của nó. Đây chỉ là cơ chế phân phối. Mô hình uncensored vẫn tuân theo cửa sổ ngữ cảnh 100.000 token và cấu trúc giá giống nhau. Truyền phát là một tính năng phía client cải thiện độ trễ cảm nhận mà không ảnh hưởng đến hành vi của mô hình.

Tích hợp Gọi hàm

Các trợ lý lập trình AI hiện đại dựa rất nhiều vào gọi hàm (gọi hàm) để tương tác với thế giới bên ngoài, chẳng hạn như chạy lệnh shell hoặc truy cập tệp. API Cursor hỗ trợ điều này qua định dạng tương thích OpenAI tiêu chuẩn.

Bạn có thể xác định các công cụ trong yêu cầu của mình bằng tham số tools. Mô hình sẽ trả về mảng tool_calls nếu nó xác định một công cụ nên được sử dụng. Ứng dụng của bạn sau đó phải thực thi công cụ và gửi kết quả lại API trong một yêu cầu tiếp theo.

Quy trình này giống hệt với cách bạn dùng khóa API github copilot với các mô hình của Microsoft. Lợi thế ở đây là tính nhất quán. Nếu bạn có mã hiện có cho gọi hàm, bạn có thể tái sử dụng nó với ít điều chỉnh. Chỉ cần đảm bảo các định nghĩa công cụ của bạn khớp với lược đồ dự kiến cho mô hình uncensored.

Theo dõi mức sử dụng

Vì bạn trả tiền theo token, việc theo dõi mức sử dụng của bạn là quan trọng để tránh chi phí không mong muốn. API Cursor cung cấp một bảng điều khiển nơi bạn có thể xem số dư tín dụng và lịch sử sử dụng. Bạn có thể xem bạn đã tiêu thụ bao nhiêu token và còn bao nhiêu tín dụng.

Các giới hạn chính cần lưu ý:

• Giới hạn tốc độ: 300 yêu cầu mỗi phút mỗi khóa.
• Kích thước thân yêu cầu: Tối đa 8 MB mỗi yêu cầu.
• Cửa sổ ngữ cảnh: Tổng cộng 100.000 token (đầu vào + đầu ra).

Nếu bạn vượt quá giới hạn tốc độ, bạn sẽ nhận được lỗi 429. Bạn có thể theo dõi mức sử dụng của mình theo thời gian thực để đảm bảo bạn vẫn nằm trong các giới hạn này. Ngoài ra, bạn có thể tạo lại khóa API của mình nếu nghi ngờ nó đã bị xâm nhập, điều này sẽ ngay lập tức vô hiệu hóa khóa cũ.

Khắc phục sự cố thường gặp

Ngay cả với một API mạnh mẽ, các vấn đề có thể phát sinh. Dưới đây là một số vấn đề phổ biến và giải pháp của chúng.

401 Không được ủy quyền: Kiểm tra khóa API của bạn. Đảm bảo nó được sao chép chính xác và không có khoảng trắng dẫn đầu hoặc cuối. Nếu bạn đã tạo lại khóa, hãy đảm bảo bạn đang dùng khóa mới.

429 Quá nhiều yêu cầu: Bạn đã vượt quá giới hạn 300 yêu cầu mỗi phút. Triển khai cơ chế backoff lũy thừa trong client của bạn hoặc giảm tần suất các yêu cầu của bạn.

400 Yêu cầu sai: Điều này thường cho thấy tải trọng JSON bị lỗi hoặc thiếu các trường bắt buộc. Đảm bảo mảng messages của bạn được định dạng chính xác và bao gồm các trường role và content. Ngoài ra, hãy xác minh rằng tên mô hình chính xác là uncensored.

Chặn nội dung: Mặc dù mô hình không kiểm duyệt, nó vẫn chặn nội dung tình dục liên quan đến trẻ vị thành niên. Nếu yêu cầu của bạn bị chặn, có thể do giới hạn cứng cụ thể này.