Pengenalan Pantas Integrasi API Character
Panduan pantas ini menjadikan API watak anda berfungsi dengan SDK OpenAI piaran dalam beberapa minit. Anda akan mengkonfigurasi URL asas, menyuntik kunci API anda, dan menghantar permintaan uncensored pertama anda.
Pasang SDK
Mula dengan memasang pustaka klien rasmi untuk bahasa anda. Ini memastikan keserasian dengan hujung sambungan serasi OpenAI yang kami sediakan. Pustaka mengendalikan serialisasi dan logik percubaan semula untuk anda.
Untuk Python, gunakan pip. Untuk Node.js, gunakan npm. Langkah ini mengambil masa beberapa saat dan menyediakan persekitaran untuk contoh kod yang seterusnya.
Konfigurasikan URL Asas Anda
Arahkan klien SDK anda ke hujung kami untuk mengakses model tanpa sensor. URL asas ialah HTTPS://api.apicharacter.com/v1. Ini menggantikan URL OpenAI lalai dalam konfigurasi anda.
Tanpa perubahan ini, permintaan akan gagal atau melanggar perkhidmatan yang salah. Anda hanya perlu menetapkan ini sekali apabila menginisialisasikan contoh klien anda.
Tetapkan Kunci API Anda
Suntik kunci anda ke pembolehubah persekitaran atau konfigurasi klien. Pengesahan diperlukan untuk setiap permintaan untuk menjejak penggunaan kredit pra-dibayar anda. Kunci anda memberikan akses ke hujung LLM tanpa sensor.
Nilai ini mesti disimpan dengan selamat. Ia bertindak sebagai kelayakan tunggal anda untuk akaun. Tiada nombor telefon atau pengesahan tambahan diperlukan untuk akses asas.
Buat Permintaan Pertama Anda
Hantar penyelesaian chat mudah untuk mengesahkan sambungan. ID model ialah "uncensored". Ini mengesahkan pengesahan identiti dan URL asas anda betul sebelum anda membina aplikasi anda.
Lihat contoh di bawah untuk permintaan cURL standard.
curl https://api.apicharacter.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "set my name to Alex"}]
}'
Tangani Respons Penstriman
Aktifkan penstriman untuk latensi yang lebih rendah dalam antara muka sembang anda. Tetapkan parameter stream kepada true dalam permintaan anda. SDK akan menghasilkan token seperti yang dijana.
Ini penting untuk pengalaman pengguna yang responsif. Anda mengendalikan potongan separa apabila ia tiba melalui Acara yang Dikirim Pelayan.
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)
Had, Ralat, dan Konteks
Memahami kekangan anda untuk mengelakkan gangguan perkhidmatan. Anda mendapat tetingkap konteks 100,000 token. Output maksimum ialah 16,000 token kecuali anda menentukan sebaliknya.
Had kadar ialah 300 permintaan setiap minit. Ralat 401 bermaksud kunci tidak sah. Ralat 402 bermaksud kredit sifar. Ralat 429 bermaksud anda mencapai had kadar. Ambil perkara ini dalam pertimbangan untuk penskalaan pengeluaran.
Python
from openai import OpenAI
client = OpenAI(base_url="https://api.apicharacter.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)Node.js
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.apicharacter.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);FAQ
Bagaimana cara mendapatkan kunci API watak saya?
Daftar dengan Google atau e-mel pada papan pemuka. Kunci API anda muncul serta-merta tanpa pengesahan nombor telefon. Anda boleh menjana kunci baharu jika perlu, menggantikan yang lama.
Adakah ini API serasi openai?
Ya, ia mengikuti format chat-completions standard. Anda hanya perlu mengubah URL asas dan kunci API. Kebanyakan SDK OpenAI berfungsi secara luar kotak dengan perubahan konfigurasi kecil.
Apa yang berlaku jika saya mendapat ralat 402?
Ia bermaksud kredit pra-dibayar anda telah habis. Muat semula melalui kripto untuk meneruskan perkhidmatan. Ralat dan penolakan tidak menggunakan kredit, jadi anda hanya membayar untuk penggunaan sebenar.
Dapatkan kunci anda serta-merta
Daftar, dapatkan kunci anda, kemas kini URL asas. Itu sahaja.