مستندات API

URL پایه و احراز هویت

نقطه پایانی API در https://api.openrouteraiapi.com/v1. کلید API خود را در Authorization هدر به عنوان یک توکن bearer. این هدر تنها تغییری است که برای هدایت ترافیک از ارائه‌دهنده فعلی شما به مدل uncensored ما نیاز دارید.

احراز هویت سخت‌گیرانه است. اگر کلید ناموجود یا نامعتبر باشد، سرور بلافاصله خطای 401 را برمی‌گرداند. می‌توانید کلیدی را به سرعت از طریق Google یا ایمیل در داشبورد تولید کنید. کلید را امن نگه دارید، زیرا دسترسی به اعتبار از پیش پرداخت‌شده شما را فراهم می‌کند.

نقطه پایانی تکمیل چت

درخواست‌های POST را به /v1/chat/completions با یک آرایه پیام. شناسه مدل uncensored. این مدل واحد تمام نیازهای تولید متن شما را بدون منطق مسیریابی پیچیده مدیریت می‌کند.

در اینجا یک درخواست استاندارد با استفاده از cURL برای تأیید اتصال و قالب پاسخ آورده شده است.

Copycurl https://api.openrouteraiapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list the top five python libraries for data science"}]
  }'

پاسخ شامل متن تولید شده در choices[0].message.content فیلد. می‌توانید این داده‌ها را مستقیماً در جریان کاری برنامه خود تجزیه کنید.

یکپارچه‌سازی SDK Python

از کلاینت رسمی Python OpenAI برای اتصال آسان استفاده کنید. تنظیم base_url و api_key متغیرها را به زیرساخت ما اشاره دهید. این رویکرد تغییرات کد را هنگام تغییر ارائه‌دهنده به حداقل می‌رساند.

Copyfrom openai import OpenAI

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

کلاینت سریال‌سازی و تلاش مجدد را به صورت خودکار مدیریت می‌کند. شما یک شیء تکمیل دریافت می‌کنید که شامل متن و آمار مصرف توکن است. این روش برای خدمات بک‌اند و اسکریپت‌ها ایده‌آل است.

استفاده از SDK Node.js

کلاینت Node.js OpenAI را با URL پایه سفارشی خود مقداردهی اولیه کنید. این به برنامه‌های جاوااسکریپت اجازه می‌دهد تا با مدل بدون سانسور با استفاده از روش‌های آشنا تعامل داشته باشند. SDK درخواست‌های HTTP را به‌طور کارآمد مدیریت می‌کند.

Copyimport OpenAI from "openai";

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

فراخوانی chat.completions.create() با پیام‌های خود. شیء پاسخ دسترسی به محتوای تولید شده و داده‌های مصرف را فراهم می‌کند. این ادغام برای سرورهای وب و توابع لبه خوب عمل می‌کند.

پاسخ‌های استریم

استریمینگ را با تنظیم stream: true در درخواست شما. سرور رویدادهای ارسالی سرور (SSE) را برای تحویل بلادرنگ توکن برمی‌گرداند. این ویژگی تأخیر ادراک‌شده برای کاربران نهایی را کاهش می‌دهد.

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)

هر قطعه شامل محتوای جزئی است. قطعه نهایی شامل آمار کامل استفاده از توکن می‌شود. این رویدادها را در کلاینت خود مدیریت کنید تا رابط کاربری را به‌تدریج به‌روزرسانی نمایید.

محدودیت‌ها، خطاها و پنجره زمینه

پنجره زمینه (context window) از ۱۰۰,۰۰۰ توکن برای ورودی و خروجی ترکیبی پشتیبانی می‌کند. هر درخواست می‌تواند تا ۱۶,۰۰۰ توکن خروجی تولید کند، یا ۲,۰۴۸ اگر max_tokens تنظیم نشده است. محدودیت‌های نرخ اجازه 300 درخواست در دقیقه در هر کلید را می‌دهند.

خطاها کدهای HTTP استاندارد هستند. 401 نشان‌دهنده کلید نامعتبر است. 402 به این معنی است که اعتبار پیش‌پرداخت شما تمام شده است. 429 نشان می‌دهد که محدودیت نرخ را عبور کرده‌اید. درخواست‌های ناموفق اعتبار مصرف نمی‌کنند. خطاها رایگان هستند.