مستندات API

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

از کلید API خود با آدرس پایه https://api.paidapi.cc/v1. کلید را در Authorization هدر به عنوان یک توکن Bearer. این پیکربندی با هر کتابخانه کلاینت سازگار با OpenAI بدون مراحل پیکربندی اضافی کار می‌کند.

Copycurl https://api.paidapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set up a cron job to run every hour"}]
  }'

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

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

یک درخواست POST به /v1/chat/completions با مدل "uncensored". آرایه پیام‌ها را در بدنه قرار دهید. API تکمیل‌های متنی را بر اساس زمینه پرامپت شما برمی‌گرداند.

Copyfrom openai import OpenAI

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

این تماس ساده تأیید می‌کند که یکپارچه‌سازی شما کار می‌کند. شیء پاسخ را برای مصرف توکن و محتوا بررسی کنید.

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

استریمینگ را با تنظیم stream: true. API قطعات ناقص را همان‌طور که تولید می‌شوند ارسال می‌کند. این امر تأخیر ادراک‌شده را برای خروجی‌های طولانی کاهش می‌دهد.

Copyimport OpenAI from "openai";

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

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

Function Calling & Tools

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

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

پیکربندی حالت JSON

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

اطمینان حاصل کنید که پرامپ شما طرحواره JSON را به وضوح مشخص می‌کند. مدل به ساختاری که تعریف می‌کنید پایبند است. این حالت را برای وظایف استخراج داده یا تولید ساختاریافته استفاده کنید.

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

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

خطاهای 401 را با تأیید کلید خود مدیریت کنید. خطاهای 402 یعنی به اعتبار بیشتری نیاز دارید. خطاها توکن مصرف نمی‌کنند. اعتبار پیش‌پرداخت خود را شارژ نگه دارید تا از وقفه‌ها جلوگیری کنید.

جریان‌سازی

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)