مرور کلی API راهیانا

راهنمای شروع کار با رابط برنامه‌نویسی کاربردی (API) راهیانا برای دسترسی به مدل‌های هوش مصنوعی.

مفاهیم اصلی API

آدرس پایه (Base URL)

تمامی درخواست‌های API نسخه 1 باید به آدرس پایه زیر ارسال شوند:

rahyana.ir/api/v1

مثال: برای دسترسی به لیست مدل‌ها، آدرس کامل

rahyana.ir/api/v1/models

خواهد بود.

احراز هویت (Authentication)

تمامی درخواست‌ها به API نیازمند احراز هویت از طریق کلید API اختصاصی شما هستند. کلید خود را در هدر

Authorization

به صورت

Bearer RAHYANA_API_KEY

ارسال کنید.

می‌توانید کلیدهای API خود را از بخش

کلیدها

مدیریت کنید.

امنیت کلید API

کلید API شما محرمانه است. آن را در کد سمت کاربر (frontend) قرار ندهید و با کسی به اشتراک نگذارید.

هدرهای پیشنهادی (Recommended Headers)

برای کمک به ما در شناسایی و پشتیبانی بهتر از برنامه‌هایی که از API راهیانا استفاده می‌کنند، توصیه می‌شود هدرهای زیر را در درخواست‌های خود ارسال کنید:

توصیه می‌شود دامنه برنامه خود را در هدر

HTTP-Referer

(مثال:

https://myapp.com

) و نام آن را در هدر

X-Title

(مثال:

My Awesome App

) ارسال کنید.

ارسال این هدرها اجباری نیست اما به بهبود کیفیت خدمات و تحلیل‌های ما کمک می‌کند.

فرمت داده‌ها (Data Format)

تمامی درخواست‌ها و پاسخ‌های API در فرمت JSON هستند. مطمئن شوید که هدر

Content-Type: application/json

را برای درخواست‌هایی که بدنه (body) دارند، ارسال می‌کنید.

خطاها (Errors)

پاسخ‌های خطا نیز در فرمت JSON و با ساختار استاندارد ارائه می‌شوند. برای اطلاعات بیشتر به صفحه

مدیریت خطاها

مراجعه کنید.

یک نمونه ساختار خطا:

{
  "error": {
    "message": "پیام خطا به زبان فارسی.",
    "type": "authentication_error | invalid_request_error | rate_limit_error | not_found_error | api_error | internal_error",
    "param": "parameter_name | null",
    "code": "RAHYANA_* | unsupported_media_* | payload_validation_failed | ..."
  },
  "suggested_models": ["optional", "array", "of", "slugs"],
  "hint": "راهنمای کوتاه برای رفع مشکل (اختیاری)",
  "docs": "/docs/<best-section>#anchor",
  "metadata": { "requestId": "<uuid>", "context": "" }
}

نمونه درخواست

curl -X GET "https://rahyana.ir/api/v1/models"   -H "Authorization: Bearer RAHYANA_API_KEY"   -H "HTTP-Referer: https://your-app.com"   -H "X-Title: Your Application Title"

نقاط پایانی (Endpoints) اصلی

تکمیل گفتگو (Chat Completions)

ارسال درخواست به مدل‌های زبان برای تولید متن، پاسخ به سوالات و مکالمات.

مشاهده مستندات تکمیل گفتگو

مدل‌ها (Models)

دریافت لیست مدل‌های موجود، جزئیات و قیمت‌گذاری آن‌ها.

مشاهده مستندات مدل‌ها

اطلاعات حساب (Account Info)

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

مشاهده مستندات حساب

مرور کلی API راهیانا

راهنمای شروع کار با رابط برنامه‌نویسی کاربردی (API) راهیانا برای دسترسی به مدل‌های هوش مصنوعی.

مفاهیم اصلی API

آدرس پایه (Base URL)

تمامی درخواست‌های API نسخه 1 باید به آدرس پایه زیر ارسال شوند:

rahyana.ir/api/v1

مثال: برای دسترسی به لیست مدل‌ها، آدرس کامل

rahyana.ir/api/v1/models

خواهد بود.

احراز هویت (Authentication)

تمامی درخواست‌ها به API نیازمند احراز هویت از طریق کلید API اختصاصی شما هستند. کلید خود را در هدر

Authorization

به صورت

Bearer RAHYANA_API_KEY

ارسال کنید.

می‌توانید کلیدهای API خود را از بخش

کلیدها

مدیریت کنید.

امنیت کلید API

کلید API شما محرمانه است. آن را در کد سمت کاربر (frontend) قرار ندهید و با کسی به اشتراک نگذارید.

هدرهای پیشنهادی (Recommended Headers)

توصیه می‌شود دامنه برنامه خود را در هدر

HTTP-Referer

(مثال:

https://myapp.com

) و نام آن را در هدر

X-Title

(مثال:

My Awesome App

) ارسال کنید.

ارسال این هدرها اجباری نیست اما به بهبود کیفیت خدمات و تحلیل‌های ما کمک می‌کند.

فرمت داده‌ها (Data Format)

تمامی درخواست‌ها و پاسخ‌های API در فرمت JSON هستند. مطمئن شوید که هدر

Content-Type: application/json

را برای درخواست‌هایی که بدنه (body) دارند، ارسال می‌کنید.

خطاها (Errors)

پاسخ‌های خطا نیز در فرمت JSON و با ساختار استاندارد ارائه می‌شوند. برای اطلاعات بیشتر به صفحه

مدیریت خطاها

مراجعه کنید.

یک نمونه ساختار خطا:

{
  "error": {
    "message": "پیام خطا به زبان فارسی.",
    "type": "authentication_error | invalid_request_error | rate_limit_error | not_found_error | api_error | internal_error",
    "param": "parameter_name | null",
    "code": "RAHYANA_* | unsupported_media_* | payload_validation_failed | ..."
  },
  "suggested_models": ["optional", "array", "of", "slugs"],
  "hint": "راهنمای کوتاه برای رفع مشکل (اختیاری)",
  "docs": "/docs/<best-section>#anchor",
  "metadata": { "requestId": "<uuid>", "context": "" }
}

نمونه درخواست

curl -X GET "https://rahyana.ir/api/v1/models"   -H "Authorization: Bearer RAHYANA_API_KEY"   -H "HTTP-Referer: https://your-app.com"   -H "X-Title: Your Application Title"

نقاط پایانی (Endpoints) اصلی

تکمیل گفتگو (Chat Completions)

ارسال درخواست به مدل‌های زبان برای تولید متن، پاسخ به سوالات و مکالمات.

مشاهده مستندات تکمیل گفتگو

مدل‌ها (Models)

دریافت لیست مدل‌های موجود، جزئیات و قیمت‌گذاری آن‌ها.

مشاهده مستندات مدل‌ها

اطلاعات حساب (Account Info)

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

مشاهده مستندات حساب

مستندات API راهیانا | راهنمای کامل برای توسعه‌دهندگان | راهیانا