مستندات API برای توسعه‌دهندگان

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

کلید API شما هر درخواست را احراز هویت می‌کند. آن را در Authorization هدر به عنوان یک توکن bearer. URL پایه https://api.keyapiglm.com/v1. این اندپوینت با هر کلاینت سازگار با OpenAI کار می‌کند. می‌توانید URL پایه استاندارد OpenAI را در کد خود جایگزین کنید. سرویس ما مسیریابی به مدل بدون سانسور ما را مدیریت می‌کند.

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

یک درخواست POST به /v1/chat/completions. شناسه مدل و پرامپت خود را شامل کنید. پاسخ شامل متن تولید شده است. می‌توانید با یک تکمیل متنی ساده شروع کنید. API ما توکن‌های خام را بدون قالب‌بندی اضافی برمی‌گرداند.

Copycurl https://api.keyapiglm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Verify endpoint latency for high traffic loads"}]
  }'

کارکرد کلید خود را فوراً آزمایش کنید. به پاسخ برای choices آرایه. هر گزینه دارای یک پیام با محتوای تولید شده شماست. خطاها کدهای HTTP استاندارد را برمی‌گردانند.

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

نصب openai بسته را تنظیم کنید. URL پایه را به نقطه پایانی ما تنظیم کنید. کلاینت را با کلید API خود راه‌اندازی کنید. نقطه پایانی chat.completions.create روش. شناسه مدل را عبور دهید uncensored. با کد موجود OpenAI کار می‌کند. نیاز به بسته‌های اضافی نیست.

Copyfrom openai import OpenAI

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

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

راه‌اندازی Node SDK

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

Copyimport OpenAI from "openai";

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

متن تولید شده را ثبت کنید. خطاها را در بلوک catch بررسی کنید. برنامه Node شما به‌طور یکپارچه ادغام می‌شود. نیازی به کلاینت‌های HTTP سفارشی نیست. پاسخ‌های JSON استاندارد به‌طور طبیعی دریافت می‌شوند.

پاسخ‌های استریم (SSE)

استریمینگ را با تنظیم stream: true. API رویدادهای ارسالی سرور ارسال می‌کند. هر قطعه حاوی متن ناقص است. این قطعات را برای دریافت پاسخ کامل به هم بچسبانید. این امر تأخیر ادراک‌شده را کاهش می‌دهد. کاربران متن را به‌صورت لحظه‌ای می‌بینند.

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 کار می‌کند. رابط کاربری شما به‌صورت بلادرنگ به‌روز می‌شود.

Limits & Errors

محدودیت نرخ ۳۰۰ درخواست در دقیقه است. درخواست‌های همزمان به ۸ به ازای هر کلید محدود می‌شوند. بدنه‌های درخواست نمی‌توانند از ۸ مگابایت تجاوز کنند. پنجره متن ۱۰۰,۰۰۰ توکن است. خطاها کدهای استاندارد را برمی‌گردانند. برای کلیدهای نامعتبر از ۴۰۱ استفاده کنید. برای اعتبار ناکافی از ۴۰۲ استفاده کنید. برای محدودیت نرخ از ۴۲۹ استفاده کنید. برای جزئیات بدنه پاسخ را بررسی کنید. منطق بازگشت مشکلات موقت را مدیریت می‌کند. یکپارچه‌سازی شما پایدار می‌ماند.