مستندات API - KimiCode

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

کد خود را به API ما متصل کنید با به‌روزرسانی URL پایه و ارائه کلید خود در هدر. ما از احراز هویت استاندارد پشتیبانی می‌کنیم، بنابراین مشتریان SDK موجود OpenAI بلافاصله بدون پیکربندی پیچیده کار می‌کنند. کلید API شما بلافاصله پس از ثبت‌نام با گوگل یا ایمیل ظاهر می‌شود، بدون نیاز به شماره تلفن.

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

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

ارسان اولین پیام با استفاده از endpoint استاندارد تکمیل چت با یک درخواست POST ساده. این تأیید می‌کند که یکپارچه‌سازی شما قبل از ورود به ویژگی‌های پیشرفته یا داده‌های streaming کار می‌کند. پاسخ شامل خروجی متنی از مدل uncensored است.

• YOUR_API_KEY را با کلید خود از داشبورد جایگزین کنید.
• مدل را روی 'uncensored' تنظیم کنید تا به مدل وزن‌باز اختصاصی ما متصل شوید.

Copycurl https://api.kimicodepricing.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available plan tiers and token costs"}]
  }'

یکپارچه‌سازی SDK Python

از کتابخانه رسمی پایتون OpenAI برای تعامل با API ما با متصل کردن آن به URL پایه ما استفاده کنید. این روش از سینتکس آشنا استفاده می‌کند و به شما اجازه می‌دهد بدون بازنویسی منطق کامل برنامه، ارائه‌دهنده را تغییر دهید. کتابخانه توکن‌بندی و قالب‌بندی درخواست‌ها را به‌طور خودکار انجام می‌دهد.

• بسته openai را از طریق pip نصب کنید.
• URL پایه را به سرویس ما تنظیم کنید.

Copyfrom openai import OpenAI

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

API ما را در برنامه‌های JavaScript یا TypeScript خود با استفاده از SDK Node ادغام کنید. این تضمین می‌کند که رفتار یکسانی در محیط‌های frontend و backend شما وجود دارد. می‌توانید پیام‌ها را ارسال کنید و پاسخ‌ها را دریافت کنید، درست مانند هر سرویس سازگار با OpenAI استاندارد.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.kimicodepricing.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) دریافت کنید. این کار تأخیر ادراک‌شده برای کاربران را کاهش می‌دهد و اجازه می‌دهد نتایج جزئی بلافاصله نمایش داده شوند. داده‌های مصرف توکن، شامل تعداد ورودی و خروجی، در قطعه نهایی جریان تعبیه شده است.

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

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)

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

مصرف خود را با درک محدودیت‌های نرخ و کدهای خطای رایج مدیریت کنید. API از یک پنجره زمینه ۱۰۰,۰۰۰ توکنی پشتیبانی می‌کند که اجازه می‌دهد تاریخچه مکالمات عمیق داشته باشید. شما به ۳۰۰ درخواست در دقیقه و ۸ درخواست همزمان به ازای هر کلید محدود هستید.

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

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