Klucz API Codex wyjaśniony dla programistów

Zrozumienie formatu klucza API

Rejestrując się w usłudze dostarczającej codex api key, otrzymujesz unikalny ciąg znaków alfanumerycznych. Klucz ten pełni funkcję Twozych poświadczeń uwierzytelniających w każdym zapytaniu wysyłanym do backendu. Format zazwyczaj podąża standardowym wzorcem, np. sk-... lub podobnymi prefiksami, w zależności od implementacji dostawcy. Jednak ponieważ korzystasz z niezależnego proxy, dokładny prefiks może się różnić. Kluczowym czynnikiem nie jest sam format, ale upewnienie się, że klucz jest poprawnie przekazywany w nagłówku HTTP Authorization jako Bearer <your_key>.

Twój klucz API jest powiązany z konkretnym kontem i poziomem użycia. W przeciwieństwie do niektórych usług, które generują wiele kluczy dla różnych środowisk (dev vs. prod), nasza konfiguracja jest prosta: jedno konto, jeden klucz. Jeśli zgubisz klucz lub podejrzewasz, że został naruszony, możesz wygenerować go ponownie natychmiast z pulpitu nawigacyjnego. Spowoduje to natychmiastowe unieważnienie starego klucza, zapewniając, że żaden nieautoryzowany dostęp nie będzie trwał. Pamiętaj, aby zaktualizować zmienne środowiskowe lub pliki konfiguracyjne za każdym razem, gdy zmieniasz klucze.

Najlepsze praktyki bezpieczeństwa

• Przechowuj swój klucz w zmiennych środowiskowych, a nie w kodzie źródłowym.
• Nigdy nie umieszczaj swojego codex api key w publicznych repozytoriach.
• Użyj funkcji regeneracji, jeśli podejrzewasz ekspozycję.

Typowy błąd: 401 Nieautoryzowany

Błąd 401 Unauthorized to najczęstszy problem podczas integracji nowego klucza API. Oznacza to, że serwer odrzucił Twoje poświadczenia uwierzytelniające. W kontekście claude code proxy lub dowolnego endpointu kompatybilnego z OpenAI prawie zawsze oznacza to, że klucz jest nieobecny, nieprawidłowy lub wygasł.

Aby zdiagnozować problem, najpierw sprawdź, czy kopiujesz klucz dokładnie tak, jak został dostarczony. Klucze są często wrażliwe na wielkość liter i mogą zawierać spacje, jeśli zostały skopiowane niepoprawnie. Upewnij się, że używasz prawidłowego adresu bazowego URL dla swojego regionu lub poziomu usługi. Jeśli niedawno wygenerowałeś klucz ponownie, upewnij się, że twój klient używa nowej wartości. Błąd 401 nie jest związany z saldem zużycia ani limitami zapytań; jest to czysta awaria uwierzytelniania.

Checklista do rozwiązania

1. Potwierdź, że ciąg klucza API dokładnie pasuje do pulpitu nawigacyjnego.
2. Sprawdź format nagłówka Authorization: Authorization: Bearer YOUR_KEY.
3. Sprawdź, czy bazowy URL jest poprawny dla Twojego typu konta.
4. Upewnij się, że nie dodano dodatkowych spacji podczas kopiowania i wklejania.

Przekroczony limit zapytań: błędy 429

Gdy przekroczysz dozwolony wolumen zapytań, API zwraca błąd 429 Too Many Requests. Dla naszej usługi limit wynosi 300 zapytań na minutę na klucz. Limit ten jest egzekwowany, aby zapewnić uczciwe korzystanie i utrzymać niskie opóźnienia dla wszystkich użytkowników. Jeśli prowadzisz sesje kodowania o dużym wolumenie, możesz szybko osiągnąć ten limit, zwłaszcza jeśli twój kod wywołuje wiele wewnętrznych zapytań.

W przypadku wystąpienia błędu 429, odpowiedź zwykle zawiera nagłówek Retry-After wskazujący, ile sekund należy odczekać przed ponowieniem próby. Implementacja wykładniczego backoffu w kodzie klienta to standardowy sposób na obsługę tych błędów w sposób poprawny. Zamiast ponawiać zapytanie natychmiast, odczekaj krótki czas, a następnie podwój czas oczekiwania przy kolejnych próbach. Zapobiega to zalewaniu serwera zapytaniami przez Twoją aplikację, dopóki limit nie zresetuje się.

Ważne jest, aby zauważyć, że limity zapytań dotyczą każdego klucza z osobna, a nie konta. Jeśli masz wiele urządzeń lub procesów używających tego samego klucza, dzielą one budżet 300 zapytań/minutę. Rozważ użycie oddzielnych kluczy dla różnych środowisk, jeśli potrzebujesz wyższego przepływu agregowanego.

Poprawna konfiguracja bazowego URL

Adres bazowy URL jest fundamentem każdej integracji API. Dla usługi kompatybilnej z OpenAI adres bazowy URL określa, gdzie są wysyłane twoje zapytania. Nasz adres bazowy URL to https://api.claudecodeapikey.com/v1. Ten URL musi być skonfigurowany w twojej bibliotece klienta lub SDK przed wysłaniem jakichkolwiek zapytań. Jeśli użyjesz niewłaściwego adresu bazowego URL, otrzymasz błędy połączenia lub nieoczekiwane odpowiedzi.

Wielu programistów używa oficjalnego SDK OpenAI dla Pythona, Node.js lub innych języków. Aby przełączyć się na nasze proxy, po prostu zaktualizuj konfigurację adresu bazowego URL. Na przykład w Pythonie możesz ustawić base_url='https://api.claudecodeapikey.com/v1'. Upewnij się, że protokół (https) i ścieżka (/v1) są poprawne. Pominięcie ścieżki /v1 to częsty błąd prowadzący do błędów 404.

Zawsze weryfikuj, czy twój klient wysyła zapytania do prawidłowego endpointu. Możesz to zrobić, sprawdzając dzienniki sieciowe lub używając narzędzia takiego jak curl do przetestowania połączenia. Pomyślne połączenie z adresem bazowym URL potwierdza, że twoja konfiguracja jest poprawna.

Obsługa odpowiedzi strumieniowych

Odpowiedzi strumieniowe pozwalają otrzymywać części odpowiedzi API w miarę ich generowania, zamiast czekać na zakończenie całej odpowiedzi. Jest to kluczowe dla agentów kodujących, które wyświetlają fragmenty kodu w czasie rzeczywistym. Nasze API obsługuje strumieniowanie za pomocą zdarzeń wysłanych przez serwer (SSE). Gdy włączysz strumieniowanie w swoim kliencie, otrzymasz strumień fragmentów, z których każdy zawiera częściową odpowiedź.

Aby włączyć strumieniowanie, ustaw parametr stream na true w swoim zapytaniu. Biblioteka klienta obsłuży następnie protokół SSE automatycznie. Możesz przetwarzać każdy fragment po jego przybyciu, aktualizując interfejs użytkownika lub rejestrując postęp. Zapewnia to lepsze doświadczenie użytkownika, szczególnie przy długich generacjach kodu.

Strumieniowanie nie zmienia podstawowego modelu ani jego możliwości. Jest to czysty mechanizm transportowy. Model nadal przetwarza cały prompt i generuje pełną odpowiedź; różnica polega na tym, jak wyjście jest dostarczane do Twojego klienta.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.claudecodeapikey.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Problemy z konfiguracją wywoływania narzędzi

Wywoływanie narzędzi (lub wywoływanie funkcji) pozwala LLM żądać konkretnych działań, takich jak uruchomienie fragmentu kodu lub zapytanie do bazy danych. Nasze API obsługuje wywoływanie narzędzi, co oznacza, że możesz zdefiniować funkcje w swoim zapytaniu i otrzymać strukturalne odpowiedzi JSON od modelu. Jest to niezbędne dla zaawansowanych agentów kodujących, które muszą interagować z systemami zewnętrznymi.

Aby skonfigurować wywoływanie funkcji, musisz podać listę definicji funkcji w parametrze tools. Każde narzędzie powinno mieć nazwę, opis i schemat parametrów. Model zdecyduje następnie, kiedy wywołać narzędzie na podstawie promptu. Jeśli model zdecyduje się wywołać narzędzie, odpowiedź będzie zawierać tablicę tool_calls z nazwą funkcji i argumentami.

Typowe problemy wynikają z nieprawidłowych definicji schematu JSON. Upewnij się, że typy parametrów i wymagane pola są dokładnie określone. Jeśli schemat jest nieprawidłowy, model może nieprawidłowo wywołać narzędzie. Przetestuj definicje swoich narzędzi prostymi promptami, aby zweryfikować, czy model rozumie oczekiwane zachowanie.

Limity okna kontekstu

Okno kontekstu definiuje maksymalną ilość tekstu, którą model może przetworzyć w jednym zapytaniu, obejmując zarówno prompt (wejście), jak i uzupełnienie (wyjście). Nasz model ma okno kontekstu wynoszące 100,000 tokenów. To znaczna ilość tekstu, ale nie jest nieskończona. Jeśli twój prompt plus oczekiwane uzupełnienie przekracza ten limit, API zwróci błąd.

Aby efektywnie zarządzać kontekstem, monitoruj użycie tokenów w swoich promptach. Długie pliki lub rozległe historie rozmów mogą szybko zużyć dostępne tokeny. Jeśli zbliżasz się do limitu, rozważ obcięcie starszych wiadomości lub zsumowanie poprzednich interakcji. Niektórzy klienci automatycznie obsługują to poprzez przesunięcie okna, ale najlepiej być świadomym limitu, aby uniknąć nieoczekiwanych błędów.

Pamiętaj, że okno kontekstu obejmuje wszystkie tokeny wysłane do modelu, w tym wiadomości systemowe, wiadomości użytkownika i wiadomości asystenta. Zaplanuj swój budżet tokenów odpowiednio, aby zapewnić płynną pracę podczas długich sesji kodowania.

Wygenerowanie klucza ponownie

Wygenerowanie ponownie klucza API to prosty proces, który zapewnia bezpieczeństwo. Jeśli podejrzewasz, że klucz został ujawniony lub chcesz okresowo zmieniać dane uwierzytelniające, możesz wygenerować nowy klucz w panelu. Stary klucz jest natychmiast unieważniany, więc wszystkie bieżące zapytania używające starego klucza zakończą się niepowodzeniem.

Po wygenerowaniu ponownie klucza upewnij się, że zaktualizowałeś wszystkie swoje klienty i konfiguracje nową wartością. Obejmuje to zmienne środowiskowe, pliki konfiguracyjne oraz dowolne wartości sztywne w kodzie. Niezaktualizowanie wszystkich miejsc może spowodować błędy uwierzytelniania w niektórych częściach aplikacji.

Nasza usługa pozwala na nieograniczoną liczbę regeneracji kluczy. Nie ma kary za częste zmienianie kluczy. Jest to dobra praktyka w utrzymaniu bezpieczeństwa, szczególnie w środowiskach współdzielonych lub przy dystrybucji kluczy członkom zespołu.

Copycurl https://api.claudecodeapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'