Kunci API Codex, dijelaskan untuk pengembang

Memahami Format Kunci API

Saat Anda mendaftar ke layanan yang menyediakan codex api key, Anda menerima string alfanumerik unik. Kunci ini bertindak sebagai kredensial autentikasi Anda untuk setiap permintaan yang dikirim ke sisi server. Formatnya biasanya mengikuti pola standar, seperti sk-... atau awalan serupa, tergantung pada implementasi penyedia. Namun, karena Anda menggunakan proxy independen, awalan pastinya mungkin berbeda. Faktor kritisnya bukan formatnya, tetapi memastikan kunci diteruskan dengan benar di header HTTP Authorization sebagai Bearer <your_key>.

Kunci API Anda terkait dengan akun tertentu dan tingkat penggunaan. Tidak seperti beberapa layanan yang menghasilkan beberapa kunci untuk lingkungan yang berbeda (dev vs. prod), pengaturan kami sangat sederhana: satu akun, satu kunci. Jika Anda kehilangan kunci Anda atau mencurigai bahwa kunci tersebut telah dikompromikan, Anda dapat membuatnya ulang segera dari dasbor Anda. Ini mencabut kunci lama secara instan, memastikan tidak ada akses tidak sah yang berlanjut. Ingatlah untuk memperbarui variabel lingkungan atau file konfigurasi Anda setiap kali Anda memutar kunci.

Praktik Terbaik Keamanan

• Simpan kunci Anda dalam variabel lingkungan, bukan dalam kode sumber Anda.
• Jangan mengirimkan codex api key Anda ke repositori publik.
• Gunakan fungsi regenerasi jika Anda mencurigai adanya paparan.

Error Umum: 401 Tidak Sah

Kesalahan 401 Tidak Sah adalah masalah paling umum saat mengintegrasikan kunci API baru. Hal ini menunjukkan bahwa server menolak kredensial autentikasi Anda. Dalam konteks claude code proxy atau endpoint kompatibel OpenAI lainnya, ini hampir selalu berarti kunci tidak ada, salah, atau kedaluwarsa.

Untuk mengatasi masalahnya, pertama-tama verifikasi bahwa Anda menyalin kunci persis seperti yang diberikan. Kunci sering kali sensitif huruf besar/kecil dan mungkin mengandung spasi jika disalin secara salah. Pastikan Anda menggunakan URL dasar yang benar untuk wilayah atau tingkat layanan Anda. Jika Anda baru saja membuat ulang kunci Anda, pastikan klien Anda menggunakan nilai baru. Error 401 tidak terkait dengan saldo penggunaan atau batas laju Anda; ini murni kegagalan autentikasi.

Daftar Periksa untuk Resolusi

1. Konfirmasi string kunci API cocok dengan dasbor persis.
2. Verifikasi format header Authorization: Authorization: Bearer YOUR_KEY.
3. Periksa bahwa URL dasar benar untuk jenis akun Anda.
4. Pastikan tidak ada spasi tambahan yang ditambahkan selama salin-tempel.

Batas Laju Dilewati: Error 429

Saat Anda melebihi volume permintaan yang diizinkan, API mengembalikan error 429 Too Many Requests. Untuk layanan kami, batasnya ditetapkan pada 300 permintaan per menit per kunci. Batas ini diterapkan untuk memastikan penggunaan yang adil dan mempertahankan latensi rendah untuk semua pengguna. Jika Anda menjalankan sesi pengkodean volume tinggi, Anda mungkin mencapai batas ini dengan cepat, terutama jika kode Anda memicu beberapa permintaan internal.

Saat error 429 terjadi, respons biasanya menyertakan header Retry-After yang menunjukkan berapa detik Anda harus menunggu sebelum mencoba lagi. Mengimplementasikan backoff eksponensial dalam kode klien Anda adalah cara standar untuk menangani error ini dengan baik. Alih-alih mencoba lagi segera, tunggu sebentar, lalu gandakan waktu tunggu untuk percobaan ulang berikutnya. Ini mencegah aplikasi Anda membanjiri server dengan permintaan saat batas direset.

Penting untuk dicatat bahwa batas laju adalah per kunci, bukan per akun. Jika Anda memiliki beberapa perangkat atau proses yang menggunakan kunci yang sama, mereka berbagi anggaran 300 permintaan/menit. Pertimbangkan untuk menggunakan kunci terpisah untuk lingkungan yang berbeda jika Anda memerlukan throughput agregat yang lebih tinggi.

Mengonfigurasi URL Dasar dengan Benar

URL dasar adalah fondasi dari integrasi API apa pun. Untuk layanan yang kompatibel dengan OpenAI, URL dasar menentukan ke mana permintaan Anda dikirim. URL dasar kami adalah https://api.claudecodeapikey.com/v1. URL ini harus dikonfigurasi di pustaka klien atau SDK Anda sebelum membuat permintaan apa pun. Jika Anda menggunakan URL dasar yang salah, Anda akan menerima error koneksi atau respons yang tidak terduga.

Banyak pengembang menggunakan SDK OpenAI resmi untuk Python, Node.js, atau bahasa lainnya. Untuk beralih ke proxy kami, Anda cukup memperbarui konfigurasi URL dasar. Misalnya, dalam Python, Anda mungkin mengatur base_url='https://api.claudecodeapikey.com/v1'. Pastikan protokol (https) dan path (/v1) benar. Melewati path /v1 adalah kesalahan umum yang mengarah ke error 404.

Selalu verifikasi bahwa klien Anda mengirim permintaan ke endpoint yang benar. Anda dapat melakukan ini dengan memeriksa log jaringan Anda atau menggunakan alat seperti curl untuk menguji koneksi. Koneksi yang berhasil ke URL dasar mengonfirmasi bahwa konfigurasi Anda benar.

Menangani Respons Streaming

Respons streaming memungkinkan Anda menerima bagian dari respons API saat dihasilkan, alih-alih menunggu seluruh respons selesai. Ini sangat penting untuk agen pengkodean yang menampilkan cuplikan kode secara real-time. API kami mendukung streaming melalui Server-Sent Events (SSE). Saat Anda mengaktifkan streaming di klien Anda, Anda akan menerima aliran potongan, masing-masing berisi respons parsial.

Untuk mengaktifkan streaming, tetapkan parameter stream menjadi true dalam permintaan Anda. Pustaka klien kemudian akan menangani protokol SSE secara otomatis. Anda dapat memproses setiap potongan saat tiba, memperbarui UI Anda atau mencatat kemajuan. Ini memberikan pengalaman pengguna yang lebih baik, terutama untuk generasi kode panjang.

Streaming tidak mengubah model dasar atau kemampuannya. Ini murni mekanisme transportasi. Model masih memproses seluruh prompt dan menghasilkan respons penuh; perbedaannya terletak pada bagaimana output dikirim ke klien Anda.

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)

Masalah Konfigurasi Pemanggilan Alat

Pemanggilan alat (atau pemanggilan fungsi) memungkinkan LLM meminta tindakan spesifik, seperti menjalankan cuplikan kode atau mengquery database. API kami mendukung pemanggilan alat, artinya Anda dapat mendefinisikan fungsi dalam permintaan Anda dan menerima respons JSON terstruktur dari model. Ini sangat penting untuk agen pengkodean canggih yang perlu berinteraksi dengan sistem eksternal.

Untuk mengonfigurasi pemanggilan alat, Anda harus menyediakan daftar definisi fungsi dalam parameter tools. Setiap alat harus memiliki nama, deskripsi, dan skema parameter. Model kemudian akan memutuskan kapan memanggil alat berdasarkan prompt. Jika model memutuskan untuk memanggil alat, respons akan menyertakan array tool_calls dengan nama fungsi dan argumen.

Masalah umum muncul dari definisi skema JSON yang salah. Pastikan tipe parameter dan bidang yang diperlukan Anda ditentukan dengan akurat. Jika skema tidak valid, model mungkin gagal memanggil alat dengan benar. Uji definisi alat Anda dengan prompt sederhana untuk memverifikasi bahwa model memahami perilaku yang diharapkan.

Batas Jendela Konteks

Jendela konteks menentukan jumlah maksimum teks yang dapat diproses model dalam satu permintaan, termasuk baik prompt (input) maupun completion (output). Model kami memiliki jendela konteks 100.000 token. Ini adalah jumlah teks yang signifikan, tetapi tidak tak terbatas. Jika prompt Anda ditambah output yang diharapkan melebihi batas ini, API akan mengembalikan error.

Untuk mengelola konteks secara efisien, pantau penggunaan token prompt Anda. File panjang atau riwayat percakapan ekstensif dapat dengan cepat menghabiskan token yang tersedia. Jika Anda mendekati batas, pertimbangkan untuk memangkas pesan lama atau meringkas interaksi sebelumnya. Beberapa klien secara otomatis menangani ini dengan menggeser jendela, tetapi lebih baik menyadari batasnya untuk menghindari error yang tidak terduga.

Ingat bahwa jendela konteks mencakup semua token yang dikirim ke model, termasuk pesan sistem, pesan pengguna, dan pesan asisten. Rencanakan anggaran token Anda dengan tepat untuk memastikan operasi yang lancar selama sesi pengkodean panjang.

Membuat Ulang Kunci Anda

Memperbarui kunci API Anda adalah proses sederhana yang memastikan keamanan. Jika Anda mencurigai kunci Anda telah terekspos atau ingin memutar kredensial secara berkala, Anda dapat membuat kunci baru dari dasbor Anda. Kunci lama segera tidak valid, sehingga setiap permintaan yang sedang berlangsung menggunakan kunci lama akan gagal.

Saat Anda memperbarui kunci, pastikan untuk memperbarui semua klien dan konfigurasi Anda dengan nilai baru. Ini termasuk variabel lingkungan, file konfigurasi, dan nilai apa pun yang ditulis secara langsung dalam kode Anda. Kegagalan untuk memperbarui semua lokasi dapat menyebabkan kesalahan autentikasi untuk beberapa bagian aplikasi Anda.

Layanan kami memungkinkan regenerasi kunci tanpa batas. Tidak ada penalti untuk memutar kunci Anda secara sering. Ini adalah praktik yang baik untuk menjaga keamanan, terutama di lingkungan bersama atau saat mendistribusikan kunci kepada anggota tim.

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."}]
  }'