Temel URL ve Kimlik Doğrulama
API'miz standart OpenAI chat-completions arayüzünü takip eder. Entegre etmek için istemci yapılandırmanızı özel temel URL'miz ve geçerli bir codex api anahtarı ile güncelleyin. Bu anahtarı, panodaki kayıt sırasında oluşturursunuz. Uç nokta hem standart hem de akış isteklerini kabul eder ve bu da onu OpenAI uyumlu yapı bekleyen çoğu ajan için doğrudan yerini alabilecek bir çözüm haline getirir.
Kimlik doğrulama Authorization üst bilgisine dayanır. Anahtarınızı Bearer token olarak ekleyin. Proxy veya özel bir ajan çerçevesi kullanıyorsanız standart HTTP üst bilgilerini desteklediğinden emin olun. Hizmet bağımsızdır; diğer satıcıların üzerinden geçmez veya modelleri birleştirmez. Doğrudan sansürsüz LLM'mize bağlanıyorsunuz.
Bir Sohbet Tamamlama Gönderme
Basit bir metin isteğiyle başlayarak test edin. Bu, kimlik doğrulamanızın ve temel URL'nizin doğru olduğunu doğrular. Uç nokta, user veya assistant gibi rolleri olan bir mesaj listesi kabul eder. Model kimliği her zaman uncensored şeklindedir. Bu istek, standart bir tamamlama yanıtı döndürür. Karmaşık istemlere geçmeden önce aracınızın JSON yapısını ayrıştırabildiğini doğrulamak için bunu kullanın.
Yükünüzün 8 MB gövde sınırında kalmasını sağlayın. Büyük bağlam pencereleri desteklenir ancak toplam token sayısı (girdi ve çıktı toplamı) 100.000 token altında kalmalıdır. Bu sınırları aşarsanız sunucu bir hata döndürür. Bağlantıyı doğrulamak için küçük bir testle başlayın.
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."}]
}'Akışı (SSE) Etkinleştirme
Gerçek zamanlı token üretimi gerektiren kodlama ajanları için akışı etkinleştirin. İstek gövnenizde stream parametresini true olarak ayarlayın. Sunucu, tek bir JSON nesnesi yerine bir dizi Sunucu Tarafından Gönderilen Olay (SSE) döndürür. Her olay, yanıtın bir parçasını içerir. Bu, kullanıcılarınız için algılanan gecikmeyi azaltır ve ajanınızın tokenları geldikçe işlemesine olanak tanır.
Akış, fiyatlandırmayı veya token sayımını değiştirmez. Toplam girdi ve çıktı tokenları için hala ödeme yaparsınız. Son yanıtı biriktirmek veya art arda işlemek için istemci kodunuzda SSE akışını işleyin. Bu, ara sonuçların yararlı olduğu kod üretimi için idealdir.
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)Araç Çağırma Kullanma
Modelimiz fonksiyon çağırma desteği sunar ve bu sayede ajanınız harici araçları çalıştırabilir. Fonksiyonlarınızı tools parametresinde tanımlayın. Model, bir fonksiyonun gerekli olduğunu belirlerse düz metin yerine bir araç çağrısı içeren bir yanıt döndürür. Ajanınızın bu yanıtı ayrıştırması, aracı çalıştırması ve sonucu görüşmeye geri beslemesi gerekir.
Bu yetenek, kod çalıştırması, veritabanı sorgulaması veya canlı veri çekme gerektiren kodlama araçları için temel öneme sahiptir. Araç şeması standart OpenAI formatını izler. Aracınızın model ile araç yürütme mantığınız arasındaki dönüşümleri doğru şekilde işlediğinden emin olun. Bu, ham metni yapılandırılmış araç sonuçlarıyla değiştirerek bağlam penceresini verimli bir şekilde korur.
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)Mevcut Modelleri Kontrol Etme
Kullanılabilir modelleri doğrulamak için GET /v1/models uç noktasını kullanın. Bu uç nokta, kimlikleri ve oluşturma tarihleri dahil olmak üzere model nesnelerinin bir listesini döndürür. API'miz tek bir model sunar: uncensored. Birden fazla sağlayıcıyı birleştiren vekil ağ geçitlerinin aksine, optimize edilmiş bir LLM için özel bir uç nokta sağlarız. Bu, kodlama görevleriniz için tutarlı davranışı ve öngörülebilir performansı garanti eder.
İstemcinizin doğru hizmete bağlandığını doğrulamak için bu uç noktayı sorgulayın. Standart meta veri alanları döndürür. Model seçimini manuel olarak yönetmenize gerek yoktur. İstemci, tüm sohbet tamamlamalarında yalnızca uncensored model kimliğini ister. Bu, entegrasyonu basitleştirir ve yönlendirme hatalarından kaçınır.
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);Hız Limitleri ve Kısıtlamalar
Kesintileri önlemek için kullanımınızı izleyin. API, ana başına dakikada 300 istek için bir hız limiti uygular. Bunu aşarsanız 429 Çok Fazla İstek hatası alırsınız. İstek gövdesi boyutu 8 MB ile sınırlıdır. Bu kısıtlamalar, yüksek verimli araçlar için kararlı performansı sağlar. Büyük toplu işler işliyorsanız istemcinizin istek sıklığını ayarlayın.
Kimlik doğrulama hataları anahtar geçersizse 401 durumunu döndürür. Yetersiz kredi 402 durumuna neden olur. İstek göndermeden önce ön ödemeli bakiyenizin pozitif olduğundan emin olun. Krediler süresi dolmaz, bu yüzden istediğiniz zaman bakiye yükleyebilirsiniz. codex api anahtarı istediğiniz zaman yenilenebilir, bu da eski anahtarı anında geçersiz kılar. Anahtarınızı güvende tutun.
