Ringkasan spesifikasi
Jika Anda sudah memiliki kode yang berkomunikasi dengan OpenAI, versi singkat dari spesifikasi API kompatibel OpenAI adalah: ubah base URL, ubah kunci, atur model ke uncensored. Body permintaan dan respons mengikuti bentuk penyelesaian chat, sehingga SDK dapat memprosesnya tanpa perubahan.
| Item | Nilai |
|---|---|
| URL dasar | https://api.unrestrictedaiapi.com/v1 |
| Otentikasi | Authorization: Bearer YOUR_KEY |
| Endpoint | POST /v1/chat/completions, GET /v1/models |
| ID model | uncensored |
| Jendela konteks | 100.000 token, prompt ditambah output |
| Ukuran badan permintaan maksimum | 8 MB |
| Output | Hanya teks |
Model ini adalah model bobot terbuka tunggal yang dijalankan oleh penyedia independen dan disesuaikan untuk menjawab tanpa menolak konten untuk penggunaan dewasa yang sah. Ini bukan endpoint resmi dari vendor model mana pun dan tidak melakukan routing antar vendor. Itulah mengapa hanya ada satu ID model dan mengapa daftar modelnya pendek.
Endpoint
GET /v1/models
Mengembalikan model yang tersedia untuk kunci API Anda. Ini adalah cara termurah untuk mengonfirmasi bahwa kunci API dan base URL Anda benar, dan banyak klien UI memanggilnya untuk mengisi dropdown.
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
Satu-satunya endpoint generasi. Anda mengirimkan array messages berisi objek dengan role (system, user, assistant atau tool) dan content, ditambah model dan opsi sampling apa pun. Contoh permintaan minimal:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
Respons membawa teks yang dihasilkan di choices[0].message.content dan hitungan token di usage. Hitungan tersebut adalah dasar penagihan.
Tidak ditawarkan: endpoint completions lama, embedding, gambar, audio dan video, fine-tuning, dan endpoint file. Klien yang memanggilnya akan menerima error, jadi nonaktifkan fitur tersebut di alat yang secara default menggunakannya.
Parameter permintaan
Parameter ini diterima dan diteruskan ke model:
temperaturedantop_puntuk sampling.stopuntuk satu atau lebih urutan berhenti.seeduntuk sampling yang dapat diulang ketika Anda menjaga variabel lain tetap sama.presence_penaltydanfrequency_penaltyuntuk mengurangi pengulangan.max_tokens, yang bersifat opsional. Jika Anda tidak menyertakannya, completion dapat menggunakan sisa jendela 100.000 token.streamuntuk server-sent events.toolsdantool_choiceuntuk pemanggilan fungsi.response_formatdengan{"type":"json_object"}untuk mode JSON.
Dua catatan praktis. Pertama, jendela konteks menghitung prompt dan jawaban bersama-sama, sehingga prompt 90.000 token menyisakan sekitar 10.000 token untuk jawaban. Kedua, batas badan permintaan adalah 8 MB, yang jauh lebih besar dari kebutuhan 100.000 token teks, sehingga Anda hanya mencapainya dengan menyematkan payload terkode besar dalam pesan.
Streaming
Atur stream: true dan respons tiba sebagai server-sent events. Setiap event adalah potongan JSON dengan delta yang berisi potongan teks berikutnya, dan penggunaan dilaporkan di akhir stream. SDK menyembunyikan framing; dengan protokol mentah, Anda membaca baris yang dimulai dengan data: hingga stream ditutup.
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
Satu aturan memengaruhi perencanaan kapasitas: permintaan yang di-stream memegang slot konkurensinya hingga stream berakhir, bukan hingga token pertama. Jika klien macet saat membaca, slot tetap sibuk. Selalu tutup atau selesaikan stream, dan atur batas waktu klien.
Pemanggilan alat dan mode JSON
Pemanggilan alat
Lewatkan tools sebagai daftar definisi fungsi dengan parameter JSON Schema. Jika model memutuskan untuk memanggil salah satunya, pesan berisi tool_calls, yang juga di-stream ketika stream aktif. Anda menjalankan fungsi dan mengirimkan kembali hasilnya sebagai pesan dengan role: "tool" dan tool_call_id yang sesuai. Gunakan tool_choice untuk memaksa fungsi tertentu atau menyerahkan keputusan kepada model.
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
Model mengusulkan argumen; model tidak mengeksekusi apa pun. Validasi argumen sebelum Anda bertindak, sebagaimana Anda melakukan dengan input pengguna apa pun.
Mode JSON
Tambahkan "response_format": {"type": "json_object"} untuk meminta objek JSON tunggal yang valid. Seperti halnya implementasi bergaya OpenAI lainnya, beri tahu model dalam prompt kunci apa yang Anda inginkan, misalnya "Kembalikan objek dengan kunci title dan tags". Parse hasilnya dalam blok try, dan biarkan max_tokens cukup besar agar objek panjang tidak terpotong.
Batas, header, dan error
| Jenis kunci | Permintaan konkuren | Permintaan per menit |
|---|---|---|
| Kunci API penuh | 8 | 300 |
| Kunci API uji coba | 2 | 60 |
Setiap respons menyertakan X-Request-Id (sebutkan saat menghubungi support), X-Balance-USD (sisa saldo Anda), X-RateLimit-Limit-Requests dan X-RateLimit-Limit-Concurrency.
Ketika Anda melewati batas, API mengembalikan HTTP 429. Kode error memisahkan kasus-kasus tersebut:
rate_limited: terlalu banyak permintaan dalam satu menit. Kurangi kecepatan atau sebarkan beban.concurrency: terlalu banyak permintaan yang sedang berjalan sekaligus. Antrikan di sisi Anda.- 429 dengan header
Retry-After: 5: kelebihan beban sementara. Tunggu lima detik dan coba lagi.
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
Permintaan yang gagal atau ditolak tidak dikenakan biaya.
Peran, riwayat, dan objek respons
API bersifat stateless. API tidak mengingat permintaan sebelumnya, sehingga percakapan hanya ada sebagai array messages yang Anda kirimkan setiap kali. Riwayat khas dimulai dengan satu pesan system yang menetapkan perilaku, diikuti oleh pesan user dan assistant yang bergantian. Ketika pemanggilan fungsi aktif, pesan tool muncul di antaranya, masing-masing terkait dengan panggilan yang dijawabnya melalui tool_call_id.
Ini memiliki dua konsekuensi. Pertama adalah biaya: setiap giliran membayar untuk seluruh riwayat sebagai input, sehingga obrolan panjang menjadi lebih mahal per pesan meskipun setiap pertanyaan pendek. Kedua adalah kontrol: Anda dapat mengedit, memangkas, atau menulis ulang riwayat sesuka hati. Menghapus giliran tertua, menggantinya dengan ringkasan, atau menyuntikkan pesan asisten yang diperbaiki adalah operasi biasa, dan model memperlakukan apa pun yang Anda kirim sebagai kebenaran.
Dalam respons, baca tiga hal. choices[0].message berisi teks atau panggilan alat. choices[0].finish_reason memberi tahu Anda mengapa proses generasi berhenti: akhir alami, batas token, atau panggilan alat. usage berisi hitungan token prompt, completion, dan total. Jika alasan penghentian menunjukkan batas token terlampaui, teks terpotong, dan Anda harus menaikkan batas atau meminta model untuk melanjutkan dalam giliran berikutnya.
Daftar periksa kompatibilitas singkat
Sebelum Anda mengirimkan klien ke endpoint ini, jalankan pemeriksaan ini. Mereka menangkap sebagian besar masalah integrasi dalam beberapa menit.
- Panggil
GET /v1/modelsdengan kunci Anda dan konfirmasi bahwa Anda menerima daftar yang mencakupuncensored. - Kirimkan permintaan obrolan biasa tanpa opsi dan konfirmasi balasan normal dengan blok
usage. - Ulangi dengan
stream: truedan konfirmasi bahwa klien Anda menangani akhir stream dan data penggunaan akhir. - Jika Anda menggunakan alat, kirimkan satu siklus panggilan alat dari awal hingga akhir, termasuk permintaan lanjutan dengan pesan
tool. - Kirimkan 10 permintaan sekaligus pada kunci uji coba dan konfirmasi bahwa kode Anda menangani 429 yang mengikuti permintaan konkuren kedua.
- Log
X-Request-Iduntuk setiap panggilan sehingga hasil aneh apa pun dapat dilacak nanti.
Melewati keenamnya berarti klien Anda siap untuk lalu lintas nyata.
Perbedaan dengan platform OpenAI lengkap
Kompatibilitas berarti protokol obrolan, bukan seluruh platform. Apa pun di luar obrolan teks tidak ada, dan beberapa perilaku berasal dari model, bukan protokol. Nama model tetap, jawaban dapat berbeda gaya dari model apa pun yang pernah Anda gunakan sebelumnya, dan pengambilan sampel dengan seed yang sama hanya dapat diulang selama prompt dan parameter tetap sama.
Satu aturan konten yang tidak dapat Anda ubah adalah bahwa konten seksual yang melibatkan anak di bawah umur diblokir. Selain itu, model disesuaikan untuk menghindari penolakan untuk penggunaan dewasa yang sah secara hukum, dan prompt tidak digunakan untuk pelatihan.
Untuk kode dalam lima bahasa lihat panduan cepat, untuk teknik prompt baca cara menulis prompt untuk model tanpa batasan, dan untuk sisi akun, harga mencantumkan tarif: $0.15 per 1M token input dan $0.50 per 1M token output, dengan kredit yang tidak pernah kedaluwarsa. dokumentasi memuat spesifikasi yang sama dalam bentuk singkat.
