مستندات API & شروع سریع

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

ابتدا کلید API خود را از داشبورد تولید کنید. ما از هدرهای استاندارد سازگار با OpenAI استفاده می‌کنیم، بنابراین تنها نیاز دارید base_url و API_KEY متغیرها. این تضمین می‌کند که یکپارچه‌سازی‌های SDK موجود شما بدون نیاز به تغییر کار می‌کنند. ما از ورود با Google یا ثبت‌نام با ایمیل/رمز عبور پشتیبانی می‌کنیم و کلید شما بلافاصله پس از ایجاد ظاهر می‌شود.

• URL پایه: https://api.routeropen.cc/v1
• هدر Auth: Authorization: Bearer YOUR_API_KEY

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

اولین درخواست

ارسان اولین پرامپت با استفاده از استاندارد chat/completions اندپوینت. شناسه مدل صرفاً uncensored. این سرویس متن را دریافت کرده و متن برمی‌گرداند؛ بدون فیلتر محتوا برای استفاده بزرگسالان قانونی.

Copycurl https://api.routeropen.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all files in current directory"}]
  }'

این درخواست ساختار پایه را نشان می‌دهد. می‌توانید پارامترهایی مانند را تنظیم کنید temperature یا top_p برای کنترل خ creativite. پاسخ شامل آمار مصرف توکن برای صورتحساب شفاف است.

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

از کتابخانه رسمی پایتون OpenAI برای یکپارچه‌سازی API استفاده کنید. کلاینت را به URL پایه ما متصل کنید و از کلید API خود استفاده کنید. این روش با کدبیس‌های موجود که قبلاً به OpenAI هدف‌گیری کرده‌اند به‌طور روان کار می‌کند.

Copyfrom openai import OpenAI

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

کتابخانه به‌طور خودکار سریال‌سازی JSON و جریان‌دهی (streaming) را مدیریت می‌کند. می‌توانید منطق تلاش مجدد و زمان‌های انتظار را مطابق نیاز پیکربندی کنید. نقطه پایانی ما از پارامترهای استاندارد پشتیبانی می‌کند که مهاجرت از سایر ارائه‌دهندگان را بسیار ساده می‌سازد.

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

برای توسعه‌دهندگان جاوااسکریپت، SDK Node با حداقل تغییرات کار می‌کند. متغیر baseURL به نقطه پایان و کلید خود را ارائه دهید. این به شما اجازه می‌دهد جریان توسعه فعلی خود را حفظ کنید در حالی که به مدل‌های بدون سانسور دسترسی دارید.

Copyimport OpenAI from "openai";

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

کاربران Node می‌توانند از الگوهای async/await برای کد تمیز بهره ببرند. ساختار پاسخ با استانداردهای OpenAI مطابقت دارد و سازگاری با تجزیه‌کننده‌های موجود را تضمین می‌کند. می‌توانید مدل یا ارائه‌دهنده را تنها با تغییر دو متغیر تغییر دهید.

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

استریمینگ را با تنظیم 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)

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

محدودیت‌ها، خطاها و & زمینه

API ما یک پنجره زمینه 100,000 توکنی و محدودیت بدنه درخواست 8 مگابایتی اعمال می‌کند. می‌توانید 300 درخواست در دقیقه به ازای هر کلید ارسال کنید. اگر این حد را تجاوز کنید، خطای محدودیت نرخ 429 دریافت خواهید کرد. شکست‌های احراز هویت 401 و اعتبار کافی 402 برمی‌گردانند.

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