راهنمای یکپارچه‌سازی برای توسعه‌دهندگان

تنظیم احراز هویت و URL پایه

ابتدا کلید API خود را از داشبورد تولید کنید. URL پایه HTTPS://api.apiaicheap.com/v1 است. کلید خود را در هدر Authorization به عنوان یک توکن bearer ارسال کنید.

• روی "دریافت کلید API" کلیک کنید و با Google یا ایمیل وارد شوید.
• کلید را بلافاصله کپی کنید؛ تنها یک بار نمایش داده می‌شود.

این کلید تمام درخواست‌ها را به endpoint تکمیل‌های چت احراز هویت می‌کند.

سربرگ مثال

Authorization: Bearer YOUR_API_KEY

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

یک تکمیل چت پایه برای آزمایش تنظیمات خود ارسال کنید. از نقطه پایانی POST /v1/chat/completions با مدل "uncensored" استفاده کنید.

این موجودی اعتبار و تأخیر (latency) شما را تأیید می‌کند.

• نقش را به "user" تنظیم کنید.
• برای اولین تست، پیام را ساده نگه دارید.

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

• به دنبال مقدار "content" باشید.

اگر کد وضعیت 200 OK دریافت کردید، یعنی یکپارچه‌سازی شما به درستی کار می‌کند.

Copycurl https://api.apiaicheap.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Fix the null pointer in the login handler"}]
  }'

یکپارچه‌سازی SDK پایتون

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

این رویکرد تلاش‌های مجدد و تجزیه JSON را به صورت خودکار مدیریت می‌کند.

• کتابخانه را از طریق pip نصب کنید.
• پارامتر base_url را به نقطه پایانی ما تنظیم کنید.

متد chat.completions.create را فراخوانی کنید.

لیست پیام‌های خود را به عنوان یک آرگومان ارسال کنید.

• نام مدل "uncensored" را شامل کنید.

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

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

Copyfrom openai import OpenAI

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

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

SDK Node.js مشابه نسخه Python کار می‌کند. کلاینت را با کلید و URL پایه ما مقداردهی اولیه کنید.

این امکان را به شما می‌دهد تا از الگوهای آشنای async/await استفاده کنید.

• پکیج OpenAI را ایمپورت کنید.
• URL پایه را در سازنده تنظیم کنید.

یک درخواست تکمیل با پیام‌های خود ایجاد کنید.

وعده (promise) را برای دریافت نتیجه مدیریت کنید.

• استخراج محتوای پیام از پاسخ.

خروجی را ثبت کنید تا بررسی کنید که آیا مدل به‌درستی پاسخ می‌دهد یا خیر.

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

Copyimport OpenAI from "openai";

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

پاسخ‌های جریان‌دار با SSE

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

این تأخیر ادراک‌شده را برای کاربران در برنامه‌های چت کاهش می‌دهد.

• stream را روی true در پیکربندی تنظیم کنید.
• هر قطعه را همان‌طور که دریافت می‌شود پردازش کنید.

قطعات را ترکیب کنید تا پاسخ نهایی تشکیل شود.

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

• فیلد "usage" را در قطعه نهایی بررسی کنید.

این رویکرد رابط کاربری را در طول تولیدهای طولانی پاسخگو نگه می‌دارد.

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)

Limits, errors, and context window

حساب شما محدودیت 300 درخواست در دقیقه به ازای هر کلید دارد. پنجره زمینه از 100,000 توکل در مجموع برای پرامپت و تکمیل پشتیبانی می‌کند.

خطاها با کدهای وضعیت HTTP استاندارد مدیریت می‌شوند.

• 401 نشان‌دهنده کلید API نامعتبر یا گمشده است.
• 402 به معنای تمام شدن اعتبار پیش‌پرداخت شما است.
• 429 نشان می‌دهد که شما از محدودیت نرخ تجاوز کرده‌اید.

ردّهاها اعتبار هزینه ندارند. خطاها نیز رایگان هستند.

حداکثر خروجی 16,000 توکن در هر درخواست است. اگر به کمتر نیاز دارید، max_tokens را تنظیم کنید.

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