OpenWebUI มี API หรือไม่? มีใน 2 รูปแบบ

API สองแบบที่คนมักหมายถึง

เมื่อมีคนถามว่า Open WebUI มี API หรือไม่ พวกเขาอาจหมายถึงทิศทางใดทิศทางหนึ่งจากสองทิศทาง การสับสนระหว่างสองสิ่งนี้เป็นสาเหตุหลักที่ทำให้คู่มือการติดตั้งดูสับสน ดังนั้นการแยกแยะให้ชัดเจนก่อนจึงเป็นเรื่องสำคัญ

• ขาเข้า: โปรแกรมของคุณส่งคำขอไปยัง Open WebUI มันทำหน้าที่เป็นเซิร์ฟเวอร์ที่มีเอนด์พอยต์สำหรับแชท โมเดล และไฟล์ ซึ่งป้องกันด้วยคีย์ API ที่คุณสร้างภายในแอป
• ขาออก: Open WebUI ส่งคำขอไปยังเซิร์ฟเวอร์โมเดล เพื่อให้หน้าต่างแชทของมันมีอะไรให้โต้ตอบ นี่คือการเชื่อมต่อที่คุณกำหนดค่าภายใต้การตั้งค่าผู้ดูแลระบบ

ดังนั้นคำตอบสั้นๆ คือใช่ทั้งสองทาง โปรเจกต์นี้บันทึก API ที่มีเอนด์พอยต์แชทในรูปแบบ OpenAI และรองรับการเชื่อมต่อไปยังเซิร์ฟเวอร์ใดๆ ที่ใช้โปรโตคอล OpenAI รายละเอียดเช่นเส้นทางที่แน่นอนและการจัดการคีย์อาจเปลี่ยนแปลงระหว่างเวอร์ชัน ดังนั้นโปรดตรวจสอบเอกสารสำหรับเวอร์ชันที่คุณใช้งาน

เว็บไซต์นี้ให้บริการโมเดลในฝั่งขาออก: API ข้อความที่โฮสต์ไว้และเข้ากันได้กับ OpenAI โดยมี ID โมเดลเดียวคือ uncensored ไม่ใช่ Open WebUI และไม่ได้รัน Open WebUI ให้คุณ Open WebUI คือซอฟต์แวร์ที่คุณโฮสต์เอง

การใช้ API ของ Open WebUI เอง

Open WebUI อนุญาตให้ผู้ใช้ที่เข้าสู่ระบบสร้างคีย์ API ในการตั้งค่าบัญชีของตน ด้วยคีย์นั้น คุณสามารถเรียกใช้เอนด์พอยต์ของมันจากสคริปต์ได้ เอนด์พอยต์แชทมีโครงสร้างตามมาตรฐาน OpenAI ดังนั้นโค้ดไคลเอนต์ที่มีอยู่จึงมักสามารถชี้ไปที่มันได้ เส้นทางที่โครงการบันทึกไว้ ณ เวลาที่เขียนคือ /api/chat/completions; ยืนยันกับเวอร์ชันของคุณ

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

หมายเหตุ: ในกรณีนี้ชื่อโมเดลคือโมเดลใดๆ ที่ Open WebUI ได้ลงทะเบียนไว้ หากคุณเชื่อมต่อ API นี้เป็นแบ็กเอนด์ ชื่อของโมเดลคือ uncensored คีย์ในการร้องขอนี้เป็นคีย์ของ Open WebUI ไม่ใช่คีย์ API ของโมเดล ทั้งสองเป็นข้อมูลประจำตัวที่แยกจากกันและมีหน้าที่ต่างกัน

ทำไมต้องใช้ API ขาเข้า? มันมีประโยชน์เมื่อคุณต้องการฟีเจอร์เสริมของ Open WebUI ผ่านโปรแกรมของคุณ เช่น ชุดความรู้ที่จัดเก็บไว้ บัญชีรายผู้ใช้ หรือการตั้งค่าโมเดล และคุณต้องการเข้าถึงฟีเจอร์เหล่านั้นโดยไม่ต้องใช้เบราว์เซอร์

การใช้ API ภายนอกเป็นแบ็กเอนด์

ทิศทางตรงกันข้ามคือสิ่งที่คนส่วนใหญ่ต้องการ Open WebUI มีส่วนสำหรับการเชื่อมต่อที่เข้ากันได้กับ OpenAI ซึ่งคุณจะต้องป้อน URL และคีย์ สำหรับบริการนี้ค่าคือ:

• URL: https://api.nsfwvideo.top/v1
• คีย์: คีย์จากหน้าคีย์
• โมเดล: uncensored ซึ่งค้นพบอัตโนมัติผ่านGET /v1/models

ทีละขั้นตอน: เปิดการตั้งค่าผู้ดูแล ไปที่การเชื่อมต่อ เพิ่มการเชื่อมต่อ API OpenAI วาง URL และคีย์ บันทึก และเลือกโมเดลในการแชทใหม่ หากคุณต้องการเริ่มต้นผ่านบรรทัดคำสั่ง ให้ตั้งค่าตัวแปรสภาพแวดล้อม OPENAI_API_BASE_URL และ OPENAI_API_KEY ขณะรันคอนเทนเนอร์

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

โปรดทราบว่า Open WebUI จะบันทึกการตั้งค่าจำนวนมากลงในฐานข้อมูลเมื่อเริ่มใช้งานครั้งแรก หากคุณเปลี่ยนตัวแปรสภาพแวดล้อมในภายหลังแล้วไม่มีอะไรเกิดขึ้น ให้แก้ไขการเชื่อมต่อในแผงผู้ดูแลระบบแทน เอกสารเริ่มต้นอย่างรวดเร็วมีรูปแบบคำขอที่แบ็กเอนด์คาดหวังไว้ หากคุณต้องการตรวจสอบด้วย curl

การเชื่อมต่อทั้งสองแบบ

คุณสามารถใช้ทั้งสองทิศทางพร้อมกันได้ แอปพลิเคชันของคุณเรียกใช้ API แบบรับเข้าของ Open WebUI โดยใช้คีย์ของ Open WebUI จากนั้น Open WebUI จะส่งต่อการสนทนาไปยังแบ็กเอนด์ที่คุณกำหนดค่าไว้ และคำตอบจะไหลกลับสู่แอปพลิเคชัน การจัดเรียงเช่นนี้มีประโยชน์ในบางสถานการณ์ เช่น ทีมของคุณใช้งาน Open WebUI อยู่แล้วพร้อมบัญชีผู้ใช้และต้องการให้สคริปต์แชร์การตั้งค่าเริ่มต้น หรือคุณต้องการจุดรวมกลางสำหรับตั้งค่าบุคลิกทั้งสำหรับมนุษย์และโปรแกรม

มันเพิ่มขั้นตอนหนึ่ง ทุกคำขอจะผ่านเซิร์ฟเวอร์ Open WebUI ของคุณก่อนจะไปถึง API ของโมเดล ดังนั้นจึงมีอีกสิ่งหนึ่งที่ต้องรัน อัปเดต และรักษาความปลอดภัย ขีดจำกัดอัตรายังซ้อนกันในลักษณะที่ไม่คาดคิด: คีย์แบ็กเอนด์อนุญาตคำขอพร้อมกัน 8 คำขอและ 300 คำขอต่อนาทีสำหรับคีย์เต็ม และผู้ใช้และสคริปต์ทั้งหมดที่ผ่านอินสแตนซ์ Open WebUI ของคุณจะแบ่งปันโควตานี้ หากแบ็กเอนด์ตอบกลับด้วย HTTP 429 พร้อมรหัสข้อผิดพลาด rate_limited หรือ concurrency ข้อผิดพลาดมักจะปรากฏเป็นข้อผิดพลาดใน Open WebUI และในโปรแกรมเรียกใช้ของคุณ

เมื่อใดควรข้าม Open WebUI และเรียก API โดยตรง

หากสิ่งที่คุณต้องการคือสคริปต์ที่สร้างข้อความ เช่น โครงเรื่อง คำอธิบายฉาก หรือบทบรรยายร่าง Open WebUI ไม่จำเป็น บริการนี้เป็นเอนด์พอยต์ที่เข้ากันได้กับ OpenAI มาตรฐาน ดังนั้น SDK มาตรฐานจึงสามารถติดต่อไปยังมันได้โดยตรง

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)

การเรียกโดยตรงให้คุณสตรีมมิงผ่าน SSE การเรียกใช้ฟังก์ชัน โหมด JSON และพารามิเตอร์การสุ่มตัวอย่างทั้งหมดโดยไม่มีการซ้อนชั้น Open WebUI เป็นตัวเลือกที่ดีกว่าเมื่อคุณต้องการอินเทอร์เฟซแชทสำหรับผู้ใช้ พร้อมประวัติ บัญชี และค่ากำหนดเริ่มต้น สคริปต์เป็นตัวเลือกที่ดีกว่าสำหรับงานแบบแบทช์ API ผลิตเฉพาะข้อความ: มันไม่แสดงวิดีโอ รูปภาพ หรือเสียง ดังนั้นสำหรับโปรเจกต์วิดีโอ มันจึงให้ส่วนข้อความเช่นสคริปต์และพรอมต์สำหรับเครื่องมืออื่น หน้า วิดีโอ pipeline อธิบายการใช้งานนั้น

คู่มือการตัดสินใจอย่างรวดเร็ว

• คุณต้องการหน้าต่างแชทสำหรับตัวเองหรือทีม: รัน Open WebUI และเพิ่มการเชื่อมต่อขาออก
• คุณต้องการให้สคริปต์ใช้ค่ากำหนดเริ่มต้นหรือบัญชีของ Open WebUI: ใช้ API ขาเข้าของมันด้วยคีย์ Open WebUI
• คุณต้องการการสร้างข้อความแบบแบตช์: เรียก API ของโมเดลโดยตรงด้วย OpenAI SDK และข้ามชั้นเพิ่มเติม
• คุณต้องการรูปภาพหรือเสียง: ทั้ง Open WebUI และ API ข้อความนี้ไม่สามารถผลิตสิ่งเหล่านั้นได้ด้วยตัวเอง ให้เชื่อมต่อเครื่องมือแยกต่างหากสำหรับขั้นตอนนี้

ไม่ว่าคุณจะเลือกเส้นทางใด ข้อเท็จจริงของโมเดลจะเหมือนกัน: หน้าต่างบริบท 100,000 โทเคนที่แชร์ระหว่างพรอมต์และคำตอบ การเรียกใช้เครื่องมือและโหมด JSON พร้อมใช้งาน และกฎแข็งเรื่องเนื้อหาทางเพศที่เกี่ยวข้องกับผู้เยาว์

หมายเหตุด้านความปลอดภัยสำหรับการเปิดเผย API อย่างใดอย่างหนึ่ง

ปฏิบัติต่อคีย์ทั้งสองเป็นความลับ คีย์ Open WebUI ให้สิทธิ์ทุกอย่างที่ผู้ใช้ที่สร้างสามารถทำได้ภายในอินสแตนซ์ของคุณ; คีย์ API ของโมเดลใช้เครดิตแบบเติมเงินล่วงหน้าของคุณ อย่าวางคีย์ใด ๆ ลงในโค้ดฝั่งไคลเอนต์หรือที่เก็บสาธารณะ

• ใส่ Open WebUI ไว้หลัง HTTPS หากเข้าถึงได้จากเครื่องอื่นนอกเหนือจากเครื่องของคุณเอง
• สร้างคีย์ Open WebUI แยกสำหรับแต่ละสคริปต์เพื่อให้คุณสามารถเพิกถอนคีย์หนึ่งโดยไม่ทำลายคีย์อื่น
• หมุนคีย์ API ของโมเดลหากมันปรากฏในบันทึกหรือภาพหน้าจอ
• ตรวจสอบส่วนหัว X-Balance-USD ในฝั่งแบ็กเอนด์เพื่อดูค่าใช้จ่ายต่อคำขอ

ในเรื่องความเป็นส่วนตัว พรอมต์ที่ส่งไปยัง API นี้ไม่ถูกใช้ในการฝึกฝน Open WebUI เองจัดเก็บประวัติการแชทในฐานข้อมูลของตัวเองบนเซิร์ฟเวอร์ของคุณ ดังนั้นตัวเลือกโฮสติ้งของคุณจึงเป็นผู้กำหนดว่าใครสามารถอ่านสิ่งนั้นได้

ต้นทุนในการรันการตั้งค่านี้

Open WebUI เป็นซอฟต์แวร์ฟรีที่คุณโฮสต์; ค่าใช้จ่ายของคุณคือเซิร์ฟเวอร์และโทเคน โทเคนคิดเงินที่ $0.15 ต่อ 1M อินพุตและ $0.50 ต่อ 1M เอาต์พุต จากเครดิตแบบเติมเงินล่วงหน้าโดยไม่มีสมาชิกภาพ การสนทนาแชทหนึ่งเทิร์นที่มี 3,000 โทเคนอินพุตและ 500 โทเคนเอาต์พุต: 3,000 x $0.15 / 1M = $0.00045 สำหรับอินพุตและ 500 x $0.50 / 1M = $0.00025 สำหรับเอาต์พุต รวมเป็น $0.0007 การสนทนา 1,000 เทิร์นเช่นนี้คิดเงิน $0.70

การเติมเงินเป็นจำนวนเต็มตั้งแต่ $20 ถึง $500 พร้อมโบนัส +5% จาก $50, +10% จาก $100 และ +15% จาก $200 ชำระเงินด้วยคริปโต USDT บน TRC20 หรือ USDC บน Base คำขอที่ล้มเหลวหรือถูกปฏิเสธจะไม่ถูกเรียกเก็บเงิน และเครดิตจะไม่หมดอายุ ผู้ใช้ใหม่สามารถขอเครดิตทดลองใช้ $0.50 เป็นเวลา 7 วันได้ด้วยการคลิกครั้งเดียวโดยไม่ต้องกรอกข้อมูลการชำระเงิน ดู หน้าราคาเพื่อดูรายละเอียดทั้งหมด

ข้อเตือนใจเกี่ยวกับเนื้อหา: โมเดลได้รับการปรับแต่งให้ตอบโดยไม่มีการปฏิเสธเนื้อหาสำหรับการใช้งานผู้ใหญ่ที่ถูกต้องตามกฎหมาย และเนื้อหาทางเพศที่เกี่ยวข้องกับผู้เยาว์จะไม่อนุญาตเป็นอันขาด

คู่มือเพิ่มเติม

• API LLM แบบ Uncensored สำหรับสายการผลิตวิดีโอ NSFW