مستند ارسال درخواست به API سازگار با OpenAI با استفاده از curl

مستند ارسال درخواست به API سازگار با OpenAI با استفاده از curl

این راهنما نحوه‌ی ارسال درخواست به سرور OpenAI-Compatible کاکوتی را با استفاده از دستور curl توضیح می‌دهد.

🔧 پیش‌نیازها

  1. داشتن توکن دسترسی (API Key) که از پنل کاکوتی دریافت کرده‌اید.
  2. نصب بودن ابزار curl روی سیستم (در لینوکس و مک معمولاً به‌صورت پیش‌فرض نصب است).
  3. آشنایی ابتدایی با ارسال درخواست HTTP.

🧭 آدرس Base URL

از آدرس زیر برای ارسال درخواست‌ها استفاده کنید:

Base URL

https://llm-api.kakoti.com/v1

🧰 ارسال درخواست

کلید API را در هدر Authorization ارسال کنید:

Authorization Header

Authorization: Bearer YOUR_API_KEY

📝 مثال درخواست

cURL Example

curl -X POST https://llm-api.kakoti.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "gpt-4o-mini", "messages": [{"role": "user", "content": "سلام"}]}'

🔌 استفاده از Postman یا Insomnia

اگر از Postman یا Insomnia برای ارسال درخواست‌های HTTP استفاده می‌کنید، می‌توانید درخواست را با استفاده از دستور curl داده شده در بالا وارد کنید.

وارد کردن curl در Insomnia

🧾 توضیحات بخش‌های مختلف دستور

بخشتوضیح
-H "Content-Type: application/json"مشخص می‌کند داده‌ها در قالب JSON ارسال می‌شوند.
-H "Authorization: Bearer <API_KEY>"کلید دسترسی را در هدر قرار می‌دهد.
-d '{ ... }'محتوای درخواست (بدنه‌ی JSON) را مشخص می‌کند.
"model"نام مدل مورد استفاده، مثلاً gpt-4o-mini, gpt-4o یا هر مدلی که سرور شما پشتیبانی می‌کند.
"messages"آرایه‌ای از پیام‌ها برای مکالمه در قالب Chat Completion API.

📤 پاسخ سرور (Response)

در صورت موفقیت، پاسخ معمولاً به شکل زیر است:

{
  "id": "chatcmpl-12345",
  "object": "chat.completion",
  "created": 1731000000,
  "model": "gpt-4o-mini",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "سلام! چطور می‌تونم کمکتون کنم؟"
      },
      "finish_reason": "stop"
    }
  ]
}