Apakah OpenWebUI Memiliki API? Ya, dalam Dua Arah

Dua API berbeda yang dimaksud orang

Ketika seseorang bertanya apakah Open WebUI memiliki API, mereka mungkin bertanya tentang salah satu dari dua arah. Mengacaukannya adalah alasan utama panduan penyiapan terasa membingungkan, jadi lebih baik memisahkannya terlebih dahulu.

• Masuk: program Anda mengirim permintaan ke Open WebUI. Ini bertindak sebagai server dengan endpoint untuk obrolan, model, dan file, yang dilindungi oleh kunci API yang Anda buat di dalam aplikasi.
• Keluar: Open WebUI mengirim permintaan ke server model agar jendela obrolannya memiliki sesuatu untuk berkomunikasi. Ini adalah koneksi yang Anda konfigurasi di Pengaturan Admin.

Jadi jawaban singkatnya adalah ya untuk keduanya. Proyek ini mendokumentasikan API dengan endpoint chat bergaya OpenAI, dan mendukung koneksi ke server apa pun yang menggunakan protokol OpenAI. Detail seperti jalur pasti dan penanganan kunci dapat berubah antar-versi, jadi periksa dokumentasi untuk rilis yang Anda jalankan.

Situs ini menyediakan model di sisi outbound: API teks yang kompatibel dengan OpenAI yang dihosting dengan ID model tunggal uncensored. Ini bukan Open WebUI dan tidak menjalankannya untuk Anda. Open WebUI adalah perangkat lunak yang Anda host sendiri.

Menggunakan API sendiri Open WebUI

Open WebUI memungkinkan pengguna yang sudah masuk membuat kunci API di pengaturan akun mereka. Dengan kunci itu, Anda dapat memanggil endpoint-nya dari skrip. Endpoint chat mengikuti bentuk OpenAI, sehingga kode klien yang ada sering dapat diarahkan ke sana. Jalur yang didokumentasikan oleh proyek pada saat penulisan adalah /api/chat/completions; konfirmasi terhadap versi Anda.

Copy# Open WebUI running locally on port 3000, key created in Settings > Account
curl http://localhost:3000/api/chat/completions \
  -H "Authorization: Bearer $OPENWEBUI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"uncensored","messages":[{"role":"user","content":"Summarize this scene in one line."}]}'

Perhatikan bahwa di sini nama model adalah model apa pun yang telah terdaftar di Open WebUI. Jika Anda menghubungkan API ini sebagai backend, nama itu adalah uncensored. Kunci dalam permintaan ini adalah kunci Open WebUI, bukan kunci API model. Mereka adalah dua kredensial terpisah dengan dua tugas terpisah.

Mengapa menggunakan API inbound sama sekali? Ini berguna ketika Anda ingin tambahan Open WebUI di balik program Anda, seperti koleksi pengetahuan tersimpannya, akun per pengguna, atau preset modelnya, dan Anda ingin mengaksesnya tanpa browser.

Menggunakan API eksternal sebagai backend

Arah lainnya adalah yang paling dibutuhkan kebanyakan orang. Open WebUI memiliki bagian untuk koneksi yang kompatibel dengan OpenAI di mana Anda memasukkan URL dan kunci. Untuk layanan ini, nilainya adalah:

• URL: https://api.nsfwvideo.top/v1
• Kunci: yang ada di halaman kunci
• Model: uncensored, ditemukan secara otomatis melalui GET /v1/models

Langkah demi langkah: buka Pengaturan Admin, buka Koneksi, tambahkan koneksi API OpenAI, tempelkan URL dan kunci, simpan, dan pilih model di chat baru. Jika Anda lebih suka memulai dari baris perintah, setel variabel lingkungan OPENAI_API_BASE_URL dan OPENAI_API_KEY saat meluncurkan kontainer.

Copydocker run -d -p 3000:8080 \
  -e OPENAI_API_BASE_URL=https://api.nsfwvideo.top/v1 \
  -e OPENAI_API_KEY=$API_KEY \
  -v open-webui:/app/backend/data \
  ghcr.io/open-webui/open-webui:main

Perhatikan bahwa Open WebUI menyimpan banyak pengaturan ke basis datanya saat pertama kali dijalankan. Jika nanti Anda mengubah variabel lingkungan dan tidak ada perubahan, edit koneksi di panel admin sebagai gantinya. panduan awal memiliki format permintaan yang diharapkan backend jika Anda ingin memverifikasinya dengan curl.

Menggabungkan keduanya

Anda dapat menggunakan kedua arah sekaligus. Aplikasi Anda memanggil API masuk Open WebUI dengan kunci Open WebUI, Open WebUI meneruskan obrolan ke backend yang Anda konfigurasi, dan balasan mengalir kembali. Susunan ini masuk akal dalam beberapa situasi: tim sudah menjalankan Open WebUI dengan akun dan ingin skrip berbagi preset-nya, atau Anda ingin satu tempat yang menyimpan pengaturan persona untuk manusia dan program.

Ini menambah satu hop. Setiap permintaan sekarang melintasi server Open WebUI Anda sebelum mencapai API model, jadi ada satu hal lagi untuk dijaga agar tetap berjalan, dipatch, dan diamankan. Batas laju juga menumpuk dengan cara yang tidak jelas: kunci backend mengizinkan 8 permintaan konkuren dan 300 per menit untuk kunci penuh, dan setiap pengguna dan skrip yang melalui instance Open WebUI Anda berbagi alokasi itu. Jika backend menjawab dengan HTTP 429, dengan kode kesalahan rate_limited atau concurrency, kegagalan biasanya akan muncul sebagai kesalahan di Open WebUI dan di pemanggil Anda.

Kapan harus melewati Open WebUI dan memanggil API secara langsung

Jika yang Anda butuhkan hanyalah skrip yang menghasilkan teks, seperti kerangka, deskripsi adegan atau narasi draf, Open WebUI tidak diperlukan. Layanan ini adalah endpoint yang kompatibel dengan OpenAI, sehingga SDK standar dapat berkomunikasi langsung dengannya.

Copyimport os
from openai import OpenAI

client = OpenAI(base_url="https://api.nsfwvideo.top/v1", api_key=os.environ["API_KEY"])

resp = client.chat.completions.create(
    model="uncensored",
    messages=[
        {"role": "system", "content": "You write concise shot lists for short films."},
        {"role": "user", "content": "Shot list for a ninety second chase through a night market."},
    ],
    temperature=0.7,
)
print(resp.choices[0].message.content)

Panggilan langsung memberikan Anda streaming melalui SSE, pemanggilan fungsi, mode JSON, dan setiap parameter sampling tanpa lapisan perantara. Open WebUI adalah pilihan yang lebih baik ketika Anda menginginkan antarmuka obrolan untuk pengguna, dengan riwayat, akun, dan preset. Skrip adalah pilihan yang lebih baik untuk pekerjaan batch. API hanya menghasilkan teks: tidak merender video, gambar, atau audio, sehingga untuk proyek video, API menyediakan bagian tertulis seperti skrip dan prompt untuk alat lain. Halaman video pipeline membahas penggunaan tersebut.

Panduan keputusan cepat

• Anda menginginkan jendela obrolan untuk diri sendiri atau tim: jalankan Open WebUI dan tambahkan koneksi keluar.
• Anda ingin skrip untuk menggunakan kembali preset atau akun Open WebUI: gunakan API masuknya dengan kunci Open WebUI.
• Anda menginginkan generasi teks batch: panggil API model secara langsung dengan SDK OpenAI dan lewati lapisan tambahan.
• Anda menginginkan gambar atau suara: baik Open WebUI maupun API teks ini tidak akan menghasilkannya sendiri. Sambungkan alat terpisah untuk langkah itu.

Terlepas dari jalur yang Anda pilih, fakta sisi model tetap sama: jendela konteks 100.000 token yang dibagikan oleh prompt dan balasan, pemanggilan alat dan mode JSON tersedia, dan aturan keras terhadap konten seksual yang melibatkan anak di bawah umur.

Catatan keamanan untuk mengekspos API mana pun

Perlakukan kedua kunci sebagai rahasia. Kunci Open WebUI memberikan apa pun yang dapat dilakukan oleh pengguna yang membuatnya di dalam instance Anda; kunci API model menghabiskan saldo prabayar Anda. Jangan tempelkan salah satu ke dalam kode sisi klien atau repositori publik.

• Letakkan Open WebUI di balik HTTPS jika dapat diakses di luar mesin Anda sendiri.
• Buat kunci Open WebUI terpisah per skrip sehingga Anda dapat mencabut satu tanpa merusak yang lain.
• Putar kunci API model jika pernah muncul di log atau screenshot.
• Perhatikan header respons X-Balance-USD di sisi backend untuk melihat pengeluaran per panggilan.

Tentang privasi, prompt yang dikirim ke API ini tidak digunakan untuk pelatihan. Open WebUI sendiri menyimpan riwayat chat di database-nya sendiri di server Anda, sehingga pilihan hosting Anda menentukan siapa yang dapat membaca itu.

Biaya untuk menjalankan pengaturan ini

Open WebUI adalah perangkat lunak gratis yang Anda host; biayanya adalah server ditambah token. Token ditagihkan sebesar $0,15 per 1 juta input dan $0,50 per 1 juta output, dari saldo prabayar tanpa langganan. Lakukan satu giliran obrolan dengan 3.000 token input dan 500 token output: 3.000 x $0,15 / 1 juta = $0,00045 untuk input dan 500 x $0,50 / 1 juta = $0,00025 untuk output, total $0,0007. Seribu giliran seperti itu berharga $0,70.

Top-up adalah jumlah bulat apa pun dari $20 hingga $500, dengan +5% dari $50, +10% dari $100 dan +15% dari $200. Pembayaran dilakukan dengan kripto, USDT pada TRC20 atau USDC pada Base. Permintaan yang gagal atau ditolak tidak dikenakan biaya, dan saldo tidak pernah kedaluwarsa. Pengguna baru dapat mengklaim uji coba gratis $0,50 selama 7 hari dengan satu klik dan tanpa detail pembayaran. Lihat halaman harga untuk gambaran lengkapnya.

Pengingat tentang konten: model ini disetel untuk menjawab tanpa penolakan konten untuk penggunaan dewasa yang sah, dan konten seksual yang melibatkan anak di bawah umur tidak pernah diizinkan.

Panduan lainnya

• API LLM Tanpa Sensor untuk Pipelines Video NSFW