راهنمای شروع سریع API

نصب SDK

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

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

این مرحله قبل از اینکه بتوانید هرگونه درخواستی به سرور ارسال کنید، الزامی است.

پیکربندی base_url و کلید

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

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

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

کارکرد کلید خود را با بررسی endpoint مدل‌ها آزمایش کنید.

اولین درخواست خود را انجام دهید

یک درخواست تکمیل چت استاندارد ارسال کنید تا پاسخ‌های متنی خام و بدون فیلتر دریافت کنید. مدل ما برای محتوای قانونی، ردّهای ایمنی استاندارد را اعمال نمی‌کند.

از uncensored شناسه مدل را برای تمام تکمیل‌ها استفاده کنید.

مثال زیر یک فراخوانی ساده تولید متن را نشان می‌دهد.

Copycurl https://api.aizonderfilter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate python code to parse json"}]
  }'

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

فعال‌سازی پاسخ‌های جریان‌دار

برای برنامه‌های با تأخیر کم، استریم را فعال کنید تا توکن‌ها را همان‌طور که تولید می‌شوند دریافت کنید. این کار تجربه کاربری بهتری برای رابط‌های چت فراهم می‌کند.

پارامتر stream را روی true در پیکربندی درخواست خود تنظیم کنید.

سرور رویدادهای ارسالی سرور (SSE) حاوی تکمیل‌های جزئی را ارسال می‌کند.

Copyfrom openai import OpenAI

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

قطعات را برای بازسازی پیام کامل تجمیع کنید. جزئیات مصرف توکن در قطره نهایی ظاهر می‌شود.

استفاده از حالت JSON و ابزارها

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

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

Copyimport OpenAI from "openai";

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

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

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

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

پنجره زمینه (Context Window) در مجموع ۱۰۰,۰۰۰ توکن پشتیبانی می‌کند. حداکثر خروجی در هر درخواست ۱۶,۰۰۰ توکن است.

خطاهای رایج HTTP را به‌درستی مدیریت کنید:

• 401 Unauthorized: کلید API شما نامعتبر یا موجود نیست.
• 402 Payment Required: اعتبار پیش‌پرداخت شما تمام شده است. برای ادامه کار با ارزهای دیجیتال شارژ کنید.
• 429 Too Many Requests: شما به محدودیت نرخ رسیده‌اید. پیش از تلاش مجدد کمی صبر کنید.

خطاها از موجودی اعتبار شما مصرف نمی‌کنند.

جریان‌سازی

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)