مستندات API

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

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

• URL پایه: https://api.hereticuncensored.com/v1
• شناسه مدل: uncensored

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

Copycurl https://api.hereticuncensored.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 features of the new release."}]
  }'

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

یک تکمیل چت ساده ارسال کنید تا اتصال را بررسی کنید. مدل بدون فیلترهای محتوایی استاندارد برای استفاده بزرگسالان قانونی پاسخ می‌دهد.

• تنظیم model به uncensored.
• کلید messages آرایه.

پاسخ را برای choices شامل متن تولید شده شما.

Copyfrom openai import OpenAI

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

کلاینت را با URL پایه و کلید خود مقداردهی اولیه کنید. این سازگاری با کتابخانه‌های استاندارد OpenAI را تضمین می‌کند.

• نصب رسمی openai بسته.
• عبور baseURL و apiKey هنگام راه‌اندازی.

فراخوانی chat.completions.create() با پرامپت. ساختار پاسخ با فرمت API استاندارد مطابقت دارد.

Copyimport OpenAI from "openai";

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

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

فعال‌سازی تحویل توکن بلادرنگ با تنظیم stream به true. این تاخیر ادراک‌شده را برای خروجی‌های بلند کاهش می‌دهد.

• Listen for delta تکه‌ها.
• قطعات را ترکیب کنید تا پاسخ کامل بازسازی شود.

متادیتای مصرف توکن در قطعه نهایی ظاهر می‌شود. این برای رابط‌های چت که بازخورد فوری نیاز دارند ایده‌آل است.

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

API از یک پنجره زمینه ۱۰۰,۰۰۰ توکنی پشتیبانی می‌کند. می‌توانید تا ۳۰۰ درخواست در دقیقه در هر کلید ارسال کنید.

• حداکثر درخواست‌های همزمان: 8
• حداکثر توکن‌های خروجی: ۱۶,۰۰۰ (پیش‌فرض ۲,۰۴۸)

عبور از محدودیت‌ها خطای ۴۲۹ را فعال می‌کند. برای حفظ نرخ انتقال ثابت برای بارهای کاری با حجم بالا، همزمانی را مدیریت کنید.

مدیریت خطا و کدها

خطاها را به شیوه‌ای مناسب مدیریت کنید تا پایداری برنامه حفظ شود. کدهای رایج شامل ۴۰۱ برای کلیدهای نامعتبر و ۴۰۲ برای اعتبار ناکافی هستند.

• 429 نشان‌دهنده تخلیه محدودیت نرخ است.
• خطای 400 نشان‌دهنده بدنه درخواست نادرست است.

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