سلامت سرویس

بررسی سلامت API

بررسی پاسخ‌گویی فرایند API، بدون نیاز به کلید.

GET/v2/health

برای بررسی در دسترس بودن API از برنامه یا ابزار مانیتورینگ خود، به این مسیر درخواست بفرستید. این مسیر عمومی است و به کلید API، سربرگ Authorization یا بدنهٔ درخواست نیاز ندارد.

بررسی پاسخ‌گویی سرویس

در صورت موفقیت، پاسخ 200 OK همراه با مقدار healthy در status و زمان سرور در فیلد timestamp برمی‌گردد. زمان سرور به وقت UTC و در قالب ISO 8601 است.

این بررسی، پاسخ‌گویی فرایند API را نشان می‌دهد و سلامت پایگاه داده یا سرویس مدل را تأیید نمی‌کند. برای بررسی مسیر کامل کوئری یا خروجی مکالمات، همان درخواست را اجرا کنید.

پاسخ

200– application/json
فرایند API پاسخ می‌دهد.
statusenum<string>الزامی
وضعیت پاسخ‌گویی فرایند API.
مقادیر مجاز: healthy
timestampstringالزامی
زمان سرور به وقت UTC، در قالب ISO 8601.
قالب: date-time
مستندات موچت