เอกสาร API ของ OpenRouter

เริ่มต้นอย่างรวดเร็ว: เชื่อมต่อกับ Python

เริ่มด้วยการติดตั้ง official SDK และชี้ไปยัง base URL ของเรา

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

• ติดตั้งไลบรารีผ่าน pip
• ตั้งค่าคีย์ API ของคุณในสภาพแวดล้อม
• กำหนด URL ฐานสำหรับเอนด์พอยต์ของเรา

Copyfrom openai import OpenAI

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

แทนที่คีย์ตัวแปรแทนที่ด้วยข้อมูลประจำตัวของคุณ คุณสามารถส่งคำขอพื้นฐานหรือข้อมูลที่มีโครงสร้างซับซ้อน

Authentication and Keys

สร้างคีย์ที่แดชบอร์ดและส่งคีย์ใน header Authorization

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

Copycurl https://api.apiopenrouter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 5 dependencies for a Go web server"}]
  }'

คำขอข้างต้นใช้ Bearer scheme ตรวจสอบให้แน่ใจว่าคีย์ของคุณขึ้นต้นด้วย sk- และไม่มีช่องว่างเพิ่มเติม

จุดจบ API Chat Completions

ส่งข้อความไปยัง /v1/chat/completions endpoint ที่ใช้ JSON มาตรฐาน

โมเดลยอมรับ user และ assistant บทบาท คุณสามารถกำหนดค่า temperature, top-p และลำดับหยุดเพื่อควบคุมสไตล์การตอบกลับ การตอบกลับจะแสดงการใช้งานโทเค็นในชิ้นสุดท้ายหากเปิดใช้งานสตรีม

Copyimport OpenAI from "openai";

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

ตั้งค่า max_tokens เพื่อควบคุมความยาวของผลลัพธ์ หากละเว้น ค่าเริ่มต้นคือ 2,048 โทเค็น โมเดลรองรับได้สูงสุด 16,000 โทเค็นต่อคำขอ

การตอบกลับแบบสตรีมมิ่ง

เปิดใช้งานการสตรีมโดยตั้งค่า stream: true ในบอดีคำขอของคุณ

รายละเอียดการใช้งานโทเค็นปรากฏเฉพาะในชิ้นสุดท้ายของสตรีม สิ่งนี้ช่วยให้อัปเดต UI แบบเรียลไทม์ในขณะที่รักษาข้อมูลการเรียกเก็บเงินที่แม่นยำ ข้อผิดพลาดระหว่างสตรีมยังคงรายงานการใช้งานสำหรับโทเค็นที่เรียกเก็บเงิน

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)

จัดการการตอบสนองแบบไม่สมบูรณ์อย่างเหมาะสม สตรีมจะปิดตามปกติเมื่อโมเดลเสร็จสิ้นการสร้างหรือถึงขีดจำกัดหน้าต่างบริบท

การเรียกใช้ฟังก์ชัน & โหมด JSON

ใช้ response_format: {type: "json_object"} เพื่อให้ได้ผลลัพธ์ JSON

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

Copycurl https://api.apiopenrouter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 5 dependencies for a Go web server"}]
  }'

ผสานการเรียกใช้ฟังก์ชันกับการสตรีมสำหรับประสบการณ์แบบโต้ตอบ ตรวจสอบผลลัพธ์ JSON ก่อนส่งต่อให้ตรรกะแอปพลิเคชันของคุณ

ขีดจำกัดและโควตา

ติดตามการใช้งานของคุณเทียบกับขีดจำกัดต่อคีย์เพื่อหลีกเลี่ยงการหยุดชะงัก

คีย์แต่ละคีย์อนุญาตให้ส่งคำขอได้ 300 คำขอต่อนาที และคำขอพร้อมกันได้ 8 คำขอ ขีดจำกัดขนาด body ของคำขอคือ 8 MB หากเกินขีดจำกัดเหล่านี้ API จะส่งสถานะ 429 ข้อผิดพลาดการตรวจสอบสิทธิ์ส่ง 401 และเครดิตไม่เพียงพอส่ง 402

Copycurl https://api.apiopenrouter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 5 dependencies for a Go web server"}]
  }'

ขนาดหน้าต่างบริบทคือ 100,000 tokens โดยรวม ข้อผิดพลาดไม่ใช้เครดิต การปฏิเสธเนื่องจากละเมิดเนื้อหาเล็กน้อยยังคงไม่เสียค่าใช้จ่าย