Dokumentasi API & Panduan Cepat

URL Dasar dan Autentikasi

Gunakan URL dasar kami dan satu kunci API untuk terhubung. Endpoint menerima header standar. Ganti YOUR_API_KEY dengan string dari dasbor Anda.

• URL Dasar: https://api.ollamaopenaicompatibleapi.com/v1
• ID Model: uncensored

Autentikasi mengandalkan token bearer. Kirimkan di Authorization header. Ini memastikan kompatibilitas dengan klien yang kompatibel dengan SDK OpenAI mana pun. Anda dapat menghasilkan kunci baru secara instan melalui Google atau email. Tidak diperlukan nomor telepon.

Endpoint Chat Completions

Kirim permintaan POST ke /v1/chat/completions. Sertakan array pesan Anda dan nama model. API mengembalikan output teks berdasarkan prompt Anda. Ini berfungsi dengan penyedia apa pun yang menggunakan parameter standar.

Atur suhu untuk kreativitas atau tetap rendah untuk presisi. Anda juga dapat menentukan urutan henti. Server memproses permintaan dan mengembalikan penyelesaian. Ini adalah interaksi inti untuk sebagian besar integrasi.

Ingat bahwa kesalahan tidak mengonsumsi kredit prabayar Anda. Hanya penyelesaian yang berhasil yang ditagih. Ini melindungi anggaran Anda selama fase debugging.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Respons Streaming melalui SSE

Aktifkan streaming dengan mengatur stream: true. Server mengirim bagian-bagian saat dihasilkan. Ini secara signifikan mengurangi latensi persepsi. Anda menerima respons parsial secara real-time.

Parse stream Server-Sent Events. Chunk terakhir berisi statistik penggunaan. Ini mencakup jumlah token untuk input dan output. Anda dapat melacak biaya secara dinamis selama generasi.

Pendekatan ini berfungsi dengan baik untuk antarmuka obrolan. Pengguna melihat teks muncul kata demi kata. Tampaknya lebih responsif daripada menunggu respons lengkap. API menangani stabilitas koneksi secara otomatis.

Copystream = 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)

Pemanggilan Fungsi dan Mode JSON

Tentukan alat dalam body permintaan Anda. Model dapat menghasilkan data terstruktur. Gunakan response_format dengan {"type": "json_object"} untuk JSON yang ketat. Ini memastikan output yang dapat diparsing setiap saat.

Definisi alat mencakup nama, deskripsi, dan parameter. Model memutuskan alat mana yang akan dipanggil. Anda mengeksekusi fungsi dan memasukkan hasilnya kembali. Ini memungkinkan alur kerja agen yang kompleks.

Mode JSON menonaktifkan generasi teks bebas. Ini memaksa model untuk mematuhi skema Anda. Gunakan ini saat mengintegrasikan dengan basis data atau API. Ini mengurangi halusinasi pada bidang terstruktur.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.ollamaopenaicompatibleapi.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)

Batas Laju dan Badan Permintaan

Anda mendapatkan 300 permintaan per menit per kunci. Konkurensi dibatasi hingga 8 permintaan simultan. Ukuran tubuh permintaan maksimum adalah 8 MB. Ini cocok untuk sebagian besar aplikasi yang padat teks.

Jendela konteks memungkinkan total 100.000 token. Ini mencakup baik prompt maupun penyelesaian. Output maksimum per permintaan adalah 16.000 token. Jika Anda mengabaikan max_tokens, secara default menjadi 2.048.

Tangani kesalahan HTTP 429 secara elegan. Mereka menunjukkan bahwa Anda mencapai batas laju. Terapkan backoff eksponensial dalam kode klien Anda. Ini mencegah membebani server selama lonjakan.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.ollamaopenaicompatibleapi.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);

Kesalahan Autentikasi dan Batas

Status 401 berarti kunci Anda tidak valid. Periksa salah ketik atau sesi yang telah kedaluwarsa. Status 402 menunjukkan kredit tidak cukup. Isi ulang melalui kripto untuk melanjutkan layanan.

Status 429 menandakan pembatasan laju. Anda melebihi 300 permintaan per menit. Kurangi throughput atau tingkatkan kunci Anda. API mengembalikan pesan kesalahan yang jelas.

Kredit tidak pernah kedaluwarsa. Anda dapat mengisi ulang kapan saja. Pengisian ulang minimum adalah $20. Kredit bonus berlaku untuk jumlah yang lebih besar. Ini menjaga proyek Anda berjalan dengan lancar.