شروع سریع API کوجیچت
از ساخت کلید تا دریافت اولین پاسخ واقعی، همراه با نمونهٔ اجرایی و روش عیبیابی.
قبل از شروع
پیشنیازها
برای اجرای نمونهها این سه مورد را آماده کنید.
- حساب ایمیلی یا موبایلی شما تأیید شده باشد.
- پلن Pro، Max یا Business داشته باشید؛ یا موجودی API شما مثبت باشد.
- یک API Key فعال از پنل بسازید و همان لحظه مقدار کامل آن را ذخیره کنید.
قدم اول
کلید را در متغیر محیطی قرار دهید
کلید نباید وارد کد منبع یا مرورگر شود.
تنظیم متغیر محیطیShell
# macOS / Linux
export KUJICHAT_API_KEY="kc_live_your_key"
# Windows PowerShell
$env:KUJICHAT_API_KEY="kc_live_your_key"قدم دوم
اولین درخواست را ارسال کنید
درخواست باید به
POST /chat/completions ارسال شود. نمونهٔ زبان دلخواه را انتخاب و اجرا کنید.درخواست کامل
curl -X POST https://kujichat.com/api/v1/chat/completions \
-H "Authorization: Bearer $KUJICHAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "kuji-v0",
"messages": [
{"role": "system", "content": "کوتاه و دقیق پاسخ بده."},
{"role": "user", "content": "REST API چیست؟"}
]
}'قدم سوم
متن پاسخ و مصرف را بخوانید
درخواست موفق وضعیت 200 دارد. متن مدل داخل choices و هزینهٔ درخواست داخل usage است.
200 OKJSON
{
"id": "chatcmpl_4a2f...",
"object": "chat.completion",
"created": 1786642500,
"model": "kuji-v0",
"choices": [{
"index": 0,
"message": {
"role": "assistant",
"content": "REST API روشی استاندارد برای ارتباط سرویسها از طریق HTTP است."
},
"finish_reason": "stop"
}],
"usage": {
"prompt_tokens": 18,
"completion_tokens": 21,
"total_tokens": 39,
"credits": 2,
"billing_source": "plan"
}
}choices[0].message.contentstringمتن تولیدشده برای نمایش یا پردازش در برنامه.
usage.creditsnumberتعداد اعتبار مصرفشده برای همین درخواست.
usage.billing_sourcestringplan یعنی از سهمیهٔ ماهانه؛ api_balance یعنی از موجودی pay-as-you-go.
اگر اجرا نشد
سه بررسی سریع
کلید پذیرفته نشد
ساختار هدر باید دقیقاً Authorization: Bearer YOUR_KEY باشد.
دسترسی یا اعتبار کافی نیست
پلن API یا موجودی pay-as-you-go را در پنل بررسی کنید.
مدل در دسترس نیست
شناسهٔ مدل را از پاسخ زندهٔ GET /models انتخاب کنید.