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

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

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

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

اولین درخواست (POST /v1/chat/completions)

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

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

از کلاینت رسمی پایتون برای تعامل بی‌درنگ با API ما استفاده کنید. URL پایه و کلید API را در شیء پیکربندی خود قبل از انجام فراخوانی‌ها تنظیم کنید. کتابخانه سریال‌سازی JSON و تجزیه پاسخ‌ها را برای شما مدیریت می‌کند. می‌توانید داده‌های مصرف را مستقیماً از شیء پاسخ دسترسی داشته باشید. این روش با هر محیط استاندارد پایتونی که از درخواست‌های async یا sync پشتیبانی می‌کند، کار می‌کند. کلید خود را در متغیرهای محیطی به صورت امن نگه دارید. نمونه کد یک فراخوانی سینک ساده را نشان می‌دهد.

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

با پروژه‌های Node.js با استفاده از مدیر بسته استاندارد ادغام کنید. کلاینت را ایمپورت کنید و URL پایه را به سمت سرورهای ما پیکربندی کنید. SDK درخواست‌های HTTP را مدیریت کرده و پاسخ‌های تایپ‌شده را برای کاربران TypeScript فراهم می‌کند. می‌توانید به راحتی هدرها را اضافه کنید یا زمان‌های انتظار را تغییر دهید. این روش برای برنامه‌های وب مدرن و سرویس‌های بک‌اند مناسب است. اطمینان حاصل کنید که نسخه Node شما با الزامات SDK سازگار است. مثال زیر یک درخواست تکمیل ساده را نشان می‌دهد.

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

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

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

حساب شما دارای پنجره زمینه 100,000 توکنی برای پرامپت و تکمیل ترکیبی است. می‌توانید تا 16,000 توکن را در یک پاسخ واحد ارسال کنید اگر مشخص کنید max_tokens. محدودیت خروجی پیش‌فرض ۲,۰۴۸ توکن است اگر این پارامتر را حذف کنید. محدودیت‌های نرخ اجازه ۳۰۰ درخواست در دقیقه و ۸ درخواست همزمان را به ازای هر کلید می‌دهند. وضعیت 401 به معنای نامعتبر بودن کلید شماست. وضعیت 402 نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. وضعیت 429 به معنای تجاوز از محدودیت نرخ است. بدنه درخواست‌ها نمی‌تواند از ۸ مگابایت تجاوز کند.

cURL

Copycurl https://api.uncensoreai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "fetch the current server status from the api endpoint"}]
  }'

پایتون

Copyfrom openai import OpenAI

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