Adres bazowy i uwierzytelnianie
Nasz API korzysta ze standardowego interfejsu chat-completions OpenAI. Aby zintegrować, zaktualizuj konfigurację klienta, podając nasz specyficzny base URL i prawidłowy codex api klucz. Generujesz ten klucz podczas rejestracji w panelu. Endpoint obsługuje zarówno standardowe, jak i strumieniowe zapytania, co czyni go bezpośrednią alternatywą dla większości agentów programistycznych oczekujących struktury kompatybilnej z OpenAI.
Uwierzytelnianie opiera się na nagłówku Authorization. Dołącz swój klucz jako token Bearer. Jeśli używasz proxy lub niestandardowego frameworka agenta, upewnij się, że respektuje on standardowe nagłówki HTTP. Usługa jest niezależna; nie przesyła ruchu przez innych dostawców ani nie agreguje modeli. Łączysz się bezpośrednio z naszym modelem LLM bez cenzury.
Wysyłanie uzupełnienia czatu
Zacznij od przetestowania prostego zapytania tekstowego. Potwierdzi to, że uwierzytelnienie i bazowy URL są poprawne. Endpoint akceptuje listę wiadomości z rolami takimi jak user lub assistant. ID modelu to zawsze uncensored. To zapytanie zwraca standardową odpowiedź completion. Użyj tego, aby zweryfikować, czy Twój agent potrafi parsować strukturę JSON przed przejściem do złożonych promptów.
Upewnij się, że ładunek mieści się w limicie 8 MB. Obsługiwane są duże okna kontekstu, ale całkowita liczba tokenów (wejście plus wyjście) musi pozostać poniżej 100 000 tokenów. Jeśli przekroczysz te limity, serwer zwróci błąd. Zacznij od małego testu, aby potwierdzić łączność.
curl https://api.getcodexapi.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."}]
}'Włącz strumieniowanie (SSE)
Dla agentów kodujących wymagających generowania tokenów w czasie rzeczywistym włącz strumieniowanie. Ustaw parametr stream na true w ciele żądania. Serwer zwraca sekwencję zdarzeń wysłanych przez serwer (SSE) zamiast pojedynczego obiektu JSON. Każde zdarzenie zawiera częściowy fragment odpowiedzi. Zmniejsza to postrzeganą opóźnienie dla Twoich użytkowników i pozwala Twojemu agentowi przetwarzać tokeny w miarę ich przybywania.
Strumieniowanie nie zmienia cen ani liczenia tokenów. Nadal płacisz za całkowitą liczbę tokenów wejściowych i wyjściowych. Obsłuż strumień SSE w kodzie klienta, aby zebrać ostateczną odpowiedź lub przetwarzać ją inkrementalnie. Jest to idealne do generowania kodu, gdzie przydatne są wyniki pośrednie.
stream = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Tell the story in second person."}],
stream=True,
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)Użyj wywoływania funkcji
Nasz model obsługuje wywoływanie funkcji, pozwalając Twojemu agentowi na wykonywanie zewnętrznych narzędzi. Zdefiniuj swoje funkcje w parametrze tools. Model zwróci odpowiedź z wywołaniem narzędzia zamiast zwykłego tekstu, jeśli uzna, że jest potrzebna funkcja. Twój agent musi sparsować tę odpowiedź i wykonać narzędzie, a następnie przekazać wynik z powrotem do rozmowy.
Ta funkcja jest niezbędna dla agentów kodujących, które muszą uruchamiać kod, odpytywać bazy danych lub pobierać dane na żywo. Schemat narzędzia odpowiada standardowemu formatowi OpenAI. Upewnij się, że Twój agent poprawnie obsługuje cykl między modelem a logiką wykonywania narzędzi. Utrzymuje to okno kontekstu efektywnie, zastępując surowy tekst strukturalnymi wynikami narzędzi.
from openai import OpenAI
client = OpenAI(base_url="https://api.getcodexapi.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)Sprawdź dostępne modele
Użyj endpointu GET /v1/models, aby zweryfikować dostępne modele. Endpoint zwraca listę obiektów modeli, w tym ich ID i daty utworzenia. Nasze API obsługuje jeden model: uncensored. W przeciwieństwie do usług proxy agregujących wielu dostawców, zapewniamy dedykowany endpoint dla jednego zoptymalizowanego LLM. Gwarantuje to spójne zachowanie i przewidywalną wydajność dla Twoich zadań kodowania.
Odpytaj ten endpoint, aby potwierdzić, że klient jest połączony z odpowiednią usługą. Zwraca standardowe pola metadanych. Nie musisz ręcznie zarządzać wyborem modelu. Klient po prostu żąda ID modelu uncensored we wszystkich uzupełnieniach czatu. Upraszcza to integrację i unika błędów routingu.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.getcodexapi.com/v1", apiKey: process.env.API_KEY });
const resp = await client.chat.completions.create({
model: "uncensored",
messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);Limity zapytań i ograniczenia
Monitoruj swoje zużycie, aby uniknąć przerw. API wymusza limit 300 zapytań na minutę na klucz. Jeśli go przekroczysz, otrzymasz błąd 429 Too Many Requests. Rozmiar ciała zapytania jest ograniczony do 8 MB. Te ograniczenia zapewniają stabilną wydajność dla agentów o wysokim przepływie. Dostosuj częstotliwość zapytań klienta, jeśli przetwarzasz duże partie.
Błędy uwierzytelnienia zwracają status 401, jeśli klucz jest nieprawidłowy. Niewystarczający kredyt skutkuje statusem 402. Upewnij się, że Twoje saldo przedpłaconego kredytu jest dodatnie przed wysłaniem zapytań. Kredyty nie wygasają, więc możesz je doładować, gdy będzie to wygodne. Klucz codex api można wygenerować ponownie w dowolnym momencie, co natychmiast unieważnia poprzedni. Chroń swój klucz.
