URL Dasar dan Autentikasi
API kami mengikuti antarmuka chat-completions OpenAI standar. Untuk mengintegrasikannya, perbarui konfigurasi klien Anda dengan URL dasar khusus kami dan kunci codex api yang valid. Anda membuat kunci ini saat mendaftar di dasbor. Endpoint ini menerima permintaan standar dan streaming, menjadikannya pengganti langsung untuk sebagian besar agen coding yang mengharapkan struktur yang kompatibel dengan OpenAI.
Autentikasi bergantung pada header Authorization. Sertakan kunci Anda sebagai token Bearer. Jika Anda menggunakan proxy atau kerangka kerja agen kustom, pastikan header HTTP standar dihormati. Layanan ini independen; tidak mengarahkan lalu lintas ke vendor lain atau menggabungkan model. Anda terhubung langsung ke LLM tanpa sensor kami.
Kirim Penyelesaian Obrolan
Mulailah dengan menguji permintaan teks sederhana. Ini mengonfirmasi bahwa autentikasi dan URL dasar Anda benar. Endpoint ini menerima daftar pesan dengan peran seperti user atau assistant. ID model selalu uncensored. Permintaan ini mengembalikan respons penyelesaian standar. Gunakan ini untuk memverifikasi bahwa agen Anda dapat memstruktur JSON sebelum melanjutkan ke prompt yang lebih kompleks.
Pastikan payload Anda tetap berada dalam batas badan 8 MB. Jendela konteks besar didukung, tetapi jumlah total token (input ditambah output) harus tetap di bawah 100.000 token. Jika Anda melebihi batas ini, server mengembalikan error. Mulai dengan tes kecil untuk memverifikasi konektivitas.
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."}]
}'Aktifkan Streaming (SSE)
Untuk agen coding yang memerlukan generasi token secara real-time, aktifkan streaming. Tetapkan parameter stream ke true dalam badan permintaan Anda. Server mengembalikan serangkaian Server-Sent Events (SSE) alih-alih objek JSON tunggal. Setiap kejadian berisi potongan parsial dari respons. Ini mengurangi latensi yang dirasakan oleh pengguna Anda dan memungkinkan agen Anda memproses token saat token tersebut tiba.
Streaming tidak mengubah harga atau penghitungan token. Anda tetap membayar untuk total token input dan output. Tangani aliran SSE dalam kode klien Anda untuk mengumpulkan respons akhir atau memprosesnya secara inkremental. Ini sangat ideal untuk generasi kode di mana hasil antara berguna.
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)Gunakan Pemanggilan Fungsi
Model kami mendukung pemanggilan fungsi, memungkinkan agen Anda menjalankan alat eksternal. Tentukan fungsi Anda dalam parameter tools. Model akan mengembalikan respons dengan panggilan fungsi alih-alih teks biasa jika menentukan fungsi diperlukan. Agen Anda harus mengurai respons ini dan menjalankan alat, lalu memasukkan hasilnya kembali ke percakapan.
Kemampuan ini sangat penting untuk agen pemrograman yang perlu menjalankan kode, mengakses basis data, atau mengambil data langsung. Skema alat mengikuti format OpenAI standar. Pastikan agen Anda menangani dengan benar putaran antara model dan logika eksekusi alat Anda. Ini menjaga jendela konteks secara efisien dengan mengganti teks mentah dengan hasil alat terstruktur.
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)Periksa Model yang Tersedia
Gunakan endpoint GET /v1/models untuk memverifikasi model yang tersedia. Endpoint ini mengembalikan daftar objek model, termasuk ID dan tanggal pembuatannya. API kami melayani satu model: uncensored. Tidak seperti proxy relay yang menggabungkan beberapa vendor, kami menyediakan endpoint khusus untuk satu LLM yang dioptimalkan. Ini memastikan perilaku yang konsisten dan kinerja yang dapat diprediksi untuk tugas pemrograman Anda.
Kueri endpoint ini untuk mengonfirmasi bahwa klien Anda terhubung ke layanan yang tepat. Ini mengembalikan bidang metadata standar. Anda tidak perlu mengelola pemilihan model secara manual. Klien hanya meminta ID model uncensored dalam semua penyelesaian obrolan. Ini menyederhanakan integrasi dan menghindari kesalahan pengalihan.
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);Batas Laju dan Kendala
Pantau penggunaan Anda untuk menghindari gangguan. API menerapkan batas 300 permintaan per menit per kunci. Jika Anda melebihi batas ini, Anda akan menerima error 429 Too Many Requests. Ukuran body permintaan dibatasi hingga 8 MB. Kendala-kendala ini memastikan kinerja stabil untuk agen dengan throughput tinggi. Sesuaikan frekuensi permintaan klien Anda jika Anda memproses batch besar.
Error autentikasi mengembalikan status 401 jika kunci tidak valid. Saldo tidak cukup mengakibatkan status 402. Pastikan saldo prabayar Anda positif sebelum mengirim permintaan. Saldo tidak kedaluwarsa, sehingga Anda dapat mengisi saldo saat nyaman. Kunci codex api dapat dibuat ulang kapan saja, sehingga kunci lama dicabut secara instan. Jaga keamanan kunci Anda.
