مستندات API

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

API برای هر درخواست نیازمند یک توکن حامل (Bearer Token) است. کلید خود را در صفحه دریافت کلید API با ورود با حساب Google یا رمز عبور ایمیل ایجاد کنید. کلید بلافاصله بدون احراز هویت تلفن ظاهر می‌شود. از URL پایه https://api.uncensoredaigithub.com/v1 با SDKهای رسمی OpenAI با به‌روزرسانی base_url و api_key مقادیر. این تنظیمات با هر کلاینت سازگار با OpenAI کار می‌کند.

نقطه پایانی: https://api.uncensoredaigithub.com/v1

هدر Auth: Authorization: Bearer YOUR_API_KEY

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

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

درخواست‌های متنی را به /v1/chat/completions اندپوینت با استفاده از شناسه مدل uncensored. API پیام‌های استاندارد را می‌پذیرد و پاسخ‌های متنی را بدون فیلترهای محتوا برای استفاده قانونی بزرگسالان برمی‌گرداند. می‌توانید پارامترهایی مانند temperature, top_p، و stop برای کنترل خلاقیت و طول خروجی.

پنجره زمینه امکان استفاده تا ۱۰۰,۰۰۰ توکن برای پرامپت و تکمیل ترکیبی را فراهم می‌کند. تنظیم max_tokens برای کنترل خروجی، با پیش‌فرض ۲,۰۴۸ توکن در صورت حذف. خطاها و رد شدن‌ها اعتبار مصرف نمی‌کنند، بنابراین می‌توانید با اطمینان تست کنید.

پاسخ‌های استریم و مصرف

استریمینگ را با تنظیم stream: true در درخواست شما. API رویدادهای ارسالی سرور (SSE) حاوی قطعات متن جزئی را برمی‌گرداند. داده‌های مصرف توکن فقط در قطعه نهایی جریان ظاهر می‌شود. این امکان رندر بلادرنگ پاسخ‌ها را در حالی که مصرف را به دقت ردیابی می‌کنید، فراهم می‌کند.

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

فراخوانی تابع و ابزارها

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

توابع را با نام‌ها، توضیحات و طرح‌های پارامتر تعریف کنید. API نام تابع و آرگومان‌ها را در پاسخ برمی‌گرداند. این آرگومان‌ها را تجزیه کنید تا کد سفارشی خود را اجرا کنید. این قابلیت، API LLM بدون سانسور را برای کارکردهای پیچیده عامل (agent) مناسب می‌سازد.

حالت JSON و پارامترها

خروجی ساختاریافته را با تنظیم response_format به {"type": "json_object"}. مدل به جای متن ساده، JSON برمی‌گرداند. این برای استخراج داده یا تولید پیکربندی مفید است. این را با فراخوانی تابع برای یکپارچه‌سازی‌های API قوی ترکیب کنید.

Other supported parameters include seed برای خروجی‌های قطعی، presence_penalty، و frequency_penalty. از seed برای بازتولید پاسخ‌های خاص جهت اشکال‌زدایی. جریمه‌ها را تنظیم کنید تا تکرار کاهش یابد یا دایره واژگان متنوع‌تری در خروجی‌ها ایجاد شود.

مدیریت خطا و محدودیت‌ها

API محدودیت نرخ ۳۰۰ درخواست در دقیقه و ۸ درخواست همزمان در کلید را اعمال می‌کند. بدنه درخواست نباید از ۸ مگابایت تجاوز کند. اگر از این محدودیت‌ها تجاوز کنید، کد وضعیت ۴۲۹ دریافت می‌کنید. خطاهای احراز هویت کد ۴۰۱ و کمبود اعتبار کد ۴۰۲ را برمی‌گردانند.

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

cURL

Copycurl https://api.uncensoredaigithub.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run the unit tests for the new auth module."}]
  }'

پایتون

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

جریان‌سازی

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)