مرجع API
مدلها
مدل موردنظر را از فهرست بهروز مدلها انتخاب کنید. قابلیتها و مسیرهای در دسترس ممکن است تغییر کنند؛ پس شناسهٔ مدل یک ارائهدهنده را در کد ثابت نکنید.
روند کار
روی هر عملیات بزنید تا همهٔ ورودیها، request، response و کدهای وضعیت آن را ببینید.
دریافت اطلاعات یک مدل
GET
/v1/models/{slug}آدرس پایهٔ API
https://api.mahvashai.irاحراز هویتAPI key پروژه یا JWT کاربر
Responseresponse مستقیم با قالب OpenAI
پارامترها
این جدول همهٔ ورودیهایی را که این endpoint میپذیرد نشان میدهد. مقدارهای نمونهها ساختگیاند و یک روش امن برای یکپارچهسازی را نشان میدهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
slug | مسیر (path) | string | الزامی | پشتیبانی میشود | شناسهٔ عمومی مدل. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت میفرستد. در همهٔ پاسخها برمیگردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازهای میسازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر میکند و هرگز دسترسی بیشتری نمیدهد. |
Request
curl -X GET 'https://api.mahvashai.ir/v1/models/<slug>' \
-H "Authorization: Bearer $MAHVASH_API_KEY"Response
{
"id": "<id>",
"object": "model",
"created": 1750000000,
"owned_by": "<value>",
"name": "example",
"display_order": 0,
"model_category": {
"id": 0,
"name": "example",
"logo": "<value>",
"is_available": true,
"created": 1750000000,
"updated": 0
},
"slug": "<value>",
"reasoning": false,
"supported_reasoning_efforts": [],
"default_reasoning_effort": "<value>",
"supported_reasoning_summaries": [],
"supported_reasoning_contexts": [],
"supported_reasoning_modes": [],
"context_window": 0,
"max_output_tokens": 0,
"is_available": true,
"updated": 0,
"supports_chat": false,
"supports_chat_completions": false,
"supports_responses": false,
"supports_streaming": true,
"supports_system_messages": true,
"supports_json_mode": false
}این نمونه فقط ساختار response را نشان میدهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 200 | request با موفقیت انجام شد. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 429 | از سقف مجاز عبور کردهاید. |
| 500 | خطای داخلی سرور. |
فهرست مدلهای فعال
GET
/v1/modelsآدرس پایهٔ API
https://api.mahvashai.irاحراز هویتAPI key پروژه یا JWT کاربر
Responseresponse مستقیم با قالب OpenAI
پارامترها
این جدول همهٔ ورودیهایی را که این endpoint میپذیرد نشان میدهد. مقدارهای نمونهها ساختگیاند و یک روش امن برای یکپارچهسازی را نشان میدهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت میفرستد. در همهٔ پاسخها برمیگردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازهای میسازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر میکند و هرگز دسترسی بیشتری نمیدهد. |
Request
curl -X GET 'https://api.mahvashai.ir/v1/models' \
-H "Authorization: Bearer $MAHVASH_API_KEY"Response
{
"object": "list",
"data": [
{
"id": "<model-id>",
"object": "model",
"owned_by": "mahvash"
}
]
}این نمونه فقط ساختار response را نشان میدهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 200 | request با موفقیت انجام شد. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 429 | از سقف مجاز عبور کردهاید. |
| 500 | خطای داخلی سرور. |