راهنمای شروع سریع apiهای مدل

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

اندپوینت در https://api.modelapis.cc/v1. کلید خود را در Authorization هدر به عنوان یک توکن bearer. سیستم درخواست‌ها با کلیدهای نامعتبر را با خطاهای 401 رد کرده و تلاش‌ها برای خرج اعتباری که ندارید را با پاسخ‌های 402 مسدود می‌کند. می‌توانید یک کلید جدید بلافاصله در داشبورد تولید کنید و کلید قدیمی بلافاصله غیرفعال می‌شود.

ارسال یک درخواست تکمیل چت (Chat Completion)

یک درخواست POST به /v1/chat/completions با تاریخچه پیام‌های خود. شناسه مدل «uncensored» است و پارامترهای استاندارد مانند temperature و top_p. این پیکربندی با هر کلاینتی که پروتکل OpenAI را پشتیبانی می‌کند، از جمله Cursor و سایر ابزارهای توسعه، کار می‌کند.

Copycurl https://api.modelapis.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "get current unix timestamp"}]
  }'

پاسخ را برای content field inside the assistant message. If you exceed your rate limit, the API returns a 429 status code. You can monitor your remaining balance directly in the dashboard dashboard without needing to parse headers manually.

پاسخ‌های استریم از طریق SSE

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

Copyfrom openai import OpenAI

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

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

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

ابزارهای خود را در tools پارامتر و تنظیم tool_choice به autoمدل فراخوانی‌های ابزار ساختاریافته را در صورت مناسب بودن برمی‌گرداند که به برنامه شما امکان می‌دهد توابع خارجی را اجرا کند. این ویژگی به‌طور یکپارچه با SDKهای استاندارد OpenAI کار می‌کند.

Copyimport OpenAI from "openai";

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

تجزیه tool_calls آرایه در پیام دستیار برای فعال‌سازی منطق بک‌اند خود. سپس می‌توانید نتایج را به عنوان پاسخ‌های ابزار به مکالمه بازگردانید. این چرخه اجازه می‌دهد جریان‌های کاری agentic پیچیده بدون خروج از API اجرا شوند.

اجبار حالت JSON

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

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

محدودیت‌های توکن و پنجره زمینه

پنجره زمینه تا ۱۰۰,۰۰۰ توکن برای مجموع ورودی و خروجی پشتیبانی می‌کند. می‌توانید تا ۱۶,۰۰۰ توکن خروجی در هر درخواست درخواست دهید. اگر مشخص نکنید max_tokens, پیش‌فرض 2,048 توکن است.

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

جریان‌سازی

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)