مستندات API

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

آدرس پایه برای تمام درخواست‌ها https://api.grokapiplatform.com/v1. با ارسال کلید منحصر‌به‌فرد API خود در Authorization هدر. هر درخواست باید این هدر را برای بررسی موجودی حساب کاربری و اعمال محدودیت‌های نرخ شامل شود.

نقطه پایانی تکمیل چت

پرس‌و‌جوهای متنی را به POST /v1/chat/completionsشناسه مدلی که باید استفاده شود "uncensored" است. این نقطه پایانی تعاملات استاندارد متن-ورودی، متن-خروجی را مدیریت می‌کند و برای استفاده پایه‌ای به پیکربندی اضافی نیاز ندارد.

Copycurl https://api.grokapiplatform.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check my current token usage balance."}]
  }'

مدل با پنجره زمینه 100,000 توکنی کار می‌کند. توکن‌های ورودی و خروجی این محدودیت را به اشتراک می‌گذارند. درخواست‌هایی که از پنجره زمینه فراتر می‌روند، بلافاصله شکست می‌خورند.

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

استریمینگ را با تنظیم stream: true در بدنه درخواست خود. سرور رویدادهای ارسال‌شده توسط سرور (SSE) را با به‌روزرسانی‌های توکن افزایشی برمی‌گرداند. از این برای نمایش‌های بلادرنگ یا کاهش تأخیر ادراک‌شده استفاده کنید.

Copyfrom openai import OpenAI

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

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

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

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

Copyimport OpenAI from "openai";

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

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

حالت JSON برای خروجی ساختاریافته

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

پارامترها و محدودیت‌ها

تنظیم temperature, top_p، و seed برای کنترل تصادفی‌سازی. حداکثر خروجی در هر درخواست ۱۶,۰۰۰ توکن است. خطاهایی مانند ۴۰۱ نشان‌دهنده کلیدهای نامعتبر، ۴۰۲ به معنای اعتبار پیش‌پرداخت ناکافی، و ۴۲۹ نشان‌دهنده محدودیت نرخ است. محدودیت ۳۰۰ درخواست در دقیقه به ازای هر کلید است. اعتبار هرگز منقضی نمی‌شود، بنابراین می‌توانید هر زمان که نیاز دارید با USDT یا USDC شارژ کنید.

جریان‌سازی

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)